From 12b182aa33096c74768ec8bd595835284b7e19a2 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 1 Aug 2024 21:34:00 +0200
Subject: [PATCH 01/13] New heading

---
 README.md | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index d8bd735..eb0e65b 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,9 @@
 # Documentation template for OS2 projects
 
-## 🏗️ Getting started 
+## How to use this template for documenting your OS2 project
 
-This is a *bare-minimum* template to create a [Jekyll][Jekyll] site that:
 
-- uses the [Just the Docs][Just the Docs] theme;
-- can be built and published on [GitHub Pages][GitHub Pages];
-- can be built and previewed locally, and published on other platforms.
-
-[Browse documentation][Just the Docs] to learn more about how to use this theme.
+[Browse documentation][Just the Docs] to learn more about features for formatting your documents
 
 Documentation in OS2 products must follow the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
 

From ffa10604dfd8017d89e714721ac5c8c14be0381f Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Fri, 2 Aug 2024 10:12:02 +0200
Subject: [PATCH 02/13] Maintainers guide

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eb0e65b..b967312 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,28 @@
 
 ## How to use this template for documenting your OS2 project
 
+## 👷 Maintainers guide
+As a part of the documentation maintainer team... 
+1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
 
-[Browse documentation][Just the Docs] to learn more about features for formatting your documents
+2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. [Organize your work in Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) and [use task lists to break down larger documentation work](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). Use [labels to prioritize and classify your issues](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to maintain an overview on what needs to be done.
+
+3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
+
+
+## 🧑‍🦰 Contributors Guide
+As a contributor
+
+
+Changes and suggestions are raised as issues
+Standardized version controlled workflow.
+
+OS2 are currently using GitHub
+
+
+[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
+
+Content guide:
 
 Documentation in OS2 products must follow the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
 

From 448a68c6abc35e67fe013e351100be151a8617ee Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 6 Aug 2024 09:42:22 +0200
Subject: [PATCH 03/13] More lnks to official github docs added

---
 README.md | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index b967312..e685fbe 100644
--- a/README.md
+++ b/README.md
@@ -6,20 +6,24 @@
 As a part of the documentation maintainer team... 
 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
 
-2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. [Organize your work in Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) and [use task lists to break down larger documentation work](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). Use [labels to prioritize and classify your issues](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to maintain an overview on what needs to be done.
+2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. 
+    - Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) 
+    - [Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
+    - [Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)  to prioritize and classify your issues and maintain an overview on what needs to be done.
 
 3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
 
+    > [!TIP]
+        > If you get stuck, os2 can help, just get in touch [os2@os2.eu](mailto:os2@os2.eu)
+
 
 ## 🧑‍🦰 Contributors Guide
 As a contributor
+1. Document suggestions and improvements by [raising issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
 
+2. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
 
-Changes and suggestions are raised as issues
-Standardized version controlled workflow.
-
-OS2 are currently using GitHub
-
+3. Using simple [Markdown](), collaborate on documentation branches with issues assigned to you by the maintainers.
 
 [Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
 

From 9b90d90ad58fb6bda942547c759a804cbc328b20 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 6 Aug 2024 10:36:54 +0200
Subject: [PATCH 04/13] Maintainer role explained, more links added

---
 README.md | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index e685fbe..2ddedbd 100644
--- a/README.md
+++ b/README.md
@@ -3,27 +3,33 @@
 ## How to use this template for documenting your OS2 project
 
 ## 👷 Maintainers guide
-As a part of the documentation maintainer team... 
+*In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
+
+
 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
 
 2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. 
     - Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) 
     - [Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
     - [Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)  to prioritize and classify your issues and maintain an overview on what needs to be done.
+    - Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
 
 3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
 
-    > [!TIP]
-        > If you get stuck, os2 can help, just get in touch [os2@os2.eu](mailto:os2@os2.eu)
+
+> [!TIP] 
+>###### In doubt or stuck with a maintainer task?
+>######  Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
 
 
 ## 🧑‍🦰 Contributors Guide
-As a contributor
-1. Document suggestions and improvements by [raising issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
+*Contributors to the documentation can be project managers, technical editors, developers and end-users.*
+
+1. Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
 
 2. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
 
-3. Using simple [Markdown](), collaborate on documentation branches with issues assigned to you by the maintainers.
+3. Collaborate on documentation branches with issues assigned to you by the maintainers.
 
 [Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
 

From 1f719bcfb9ca92ad23dda994a0e727fff0aa315a Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 27 Aug 2024 14:09:11 +0200
Subject: [PATCH 05/13] Even shorter and to the point Setup phase added

---
 README.md | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 2ddedbd..12d06c6 100644
--- a/README.md
+++ b/README.md
@@ -3,32 +3,38 @@
 ## How to use this template for documenting your OS2 project
 
 ## 👷 Maintainers guide
+
 *In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
 
+#### Setup
 
 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
+3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live!
+4. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages to your docs.
+
+#### Maintenance
+
+1. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements.
 
-2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. 
-    - Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) 
+    - Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones)
     - [Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
     - [Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)  to prioritize and classify your issues and maintain an overview on what needs to be done.
     - Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
 
-3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
-
-
-> [!TIP] 
->###### In doubt or stuck with a maintainer task?
->######  Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
+2. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
 
+> [!TIP]
+>
+> ###### In doubt or stuck with a maintainer task?
+>
+> ###### Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
 
 ## 🧑‍🦰 Contributors Guide
+
 *Contributors to the documentation can be project managers, technical editors, developers and end-users.*
 
 1. Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
-
 2. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
-
 3. Collaborate on documentation branches with issues assigned to you by the maintainers.
 
 [Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
@@ -43,6 +49,7 @@ Documentation in OS2 products must follow the documentation criteria from the [S
 Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.
 
 ## Contributing
+
 Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
 
 ## Licensing and Attribution

From 2493f207ee08447d1e902a01ee07b3847044f0f3 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Mon, 21 Oct 2024 15:29:20 +0200
Subject: [PATCH 06/13] Headline added

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 12d06c6..f9632d5 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
 
 *In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
 
-#### Setup
+# Setup
 
 1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
 3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live!

From 151200dc40a94a3db7a5f57626fa9a1cda98df2a Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 24 Oct 2024 12:45:23 +0000
Subject: [PATCH 07/13] Added a CONTRIBUTIING.md

---
 CONTRIBUTING.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..03e622f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contributing to OS2 Documentation
+
+Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome contributions that help improve our documentation and ensure it meets the needs of our community.
+
+To open up our codebases and fosters collaboration and transparency and encourage more organizations to use and adapt our open source products OS2 follows the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
+
+- [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) 
+- [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html)
+- [Document codebase Maturity]
+
+## How to Contribute
+
+1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information. 
+
+2. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
+3. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
+4. Collaborate on documentation branches with issues assigned to you by the maintainers.
+
+[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
+
+
+Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.

From 4eccd3499a192412086ae7532652fd1cdbc28ede Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 24 Oct 2024 12:45:49 +0000
Subject: [PATCH 08/13] Refactored the README to be a temporary quickstart

---
 README.md | 56 +++++++++++--------------------------------------------
 1 file changed, 11 insertions(+), 45 deletions(-)

diff --git a/README.md b/README.md
index f9632d5..4b4c7db 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,22 @@
-# Documentation template for OS2 projects
+# OS2 Documentation Template
 
-## How to use this template for documenting your OS2 project
+This template helps you quickly set up documentation for your OS2 project.
 
-## 👷 Maintainers guide
+## Quick Start
 
-*In OS2 projects the maintainer team is the group of individuals assigned to oversee the development, quality, and community engagement of the documentation project.*
+1. Click the green "Use this template" button above.
+2. Name your new repository and create it.
+3. Start with the `PROJECT_README_TEMPLATE.md` file and 
+4. Replace this Quick Start by renaming `PROJECT_README_TEMPLATE.md` to `README.md`:
+  
+5. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). 
 
-# Setup
+That's it! Your project documentation scafolding is now set up and your documentation site is now live!
 
-1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
-3. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). The documentation site is now live!
-4. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages to your docs.
-
-#### Maintenance
-
-1. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements.
-
-    - Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones)
-    - [Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
-    - [Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)  to prioritize and classify your issues and maintain an overview on what needs to be done.
-    - Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
-
-2. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
-
-> [!TIP]
->
-> ###### In doubt or stuck with a maintainer task?
->
-> ###### Try [these Best Practice advice for maintaining collaborative, safe, and effective communities.](https://docs.github.com/en/communities)
-
-## 🧑‍🦰 Contributors Guide
-
-*Contributors to the documentation can be project managers, technical editors, developers and end-users.*
-
-1. Document suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
-2. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
-3. Collaborate on documentation branches with issues assigned to you by the maintainers.
-
-[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
-
-Content guide:
-
-Documentation in OS2 products must follow the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
-
-1. [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html)
-2. [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html)
-
-Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.
 
 ## Contributing
 
-Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
+Feel free to contribute, to get started check out our [CONTRIBUTING.md](./CONTRIBUTING.md) guide
 
 ## Licensing and Attribution
 

From f357763c6cffdf5b27181415f3af77d030a2ebb8 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 29 Oct 2024 14:16:28 +0100
Subject: [PATCH 09/13] Refactored CONTRIBUTING guide

---
 CONTRIBUTING.md | 30 ++++++++++++++++--------------
 1 file changed, 16 insertions(+), 14 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 03e622f..1311ece 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,22 +1,24 @@
 # Contributing to OS2 Documentation
 
-Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome contributions that help improve our documentation and ensure it meets the needs of our community.
+Contributors to the documentation can be project managers, technical editors, developers, and end-users.  We welcome all contributions that help improve our documentation.
 
-To open up our codebases and fosters collaboration and transparency and encourage more organizations to use and adapt our open source products OS2 follows the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
+To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of [Docs As Code](https://openpracticelibrary.com/practice/docs-as-code/) and the open [Markdown](https://en.wikipedia.org/wiki/Markdown) format for ease of collaboration and quality control.
 
-- [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) 
-- [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html)
-- [Document codebase Maturity]
+To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/). 
+<br>
+<br>
 
-## How to Contribute
+## 🚀 Quick start
 
-1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information. 
+1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information.
+2. Follow the criteria from [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html), [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) and [Document codebase Maturity]()
+in one or several text documents using the Markdown format.
+3. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
+4. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
+5. Collaborate on documentation branches with issues assigned to you by the maintainers.
 
-2. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
-3. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
-4. Collaborate on documentation branches with issues assigned to you by the maintainers.
+> 📚 Read more about:
+> 
+> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation  
+> How [Just the Docs](https://just-the-docs.github.io/just-the-docs/) is used to generate a documentation site from your markdown files.
 
-[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
-
-
-Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.

From 99c95f062c980a4c50f86e5240658ac5cc5d313d Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 5 Nov 2024 15:34:42 +0100
Subject: [PATCH 10/13] Refactored to a Hybrid README The README is now heavily
 templated with purple text both representing the template text to be removed
 AND text that explains the expected input into the template In the top of the
 README is now a quick start guide, that needs to be removed, after completed.

---
 README.md | 58 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 31 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 4b4c7db..36cb1de 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,44 @@
-# OS2 Documentation Template
+> [!WARNING] Remove this section from your README.md after completing all setup tasks!
+> - [ ] Click the green "Use this template" button above.
+> - [ ] Name your new repository and create it.
+> - [ ] Replace all the purple placeholder texts with your project-specific information.
+> - [ ] Add any additional relevant Markdown documents to your documentation.
+> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
+> - [ ] **Remove this setup section from your README.md.**
+>
+> That's it! You are now set up, and your documentation site is live!
 
-This template helps you quickly set up documentation for your OS2 project.
 
-## Quick Start
+# [Replace with Project Title]
+> [!IMPORTANT] [Replace with a clear statement defining the mission and goals of your project in simple terms.]
 
-1. Click the green "Use this template" button above.
-2. Name your new repository and create it.
-3. Start with the `PROJECT_README_TEMPLATE.md` file and 
-4. Replace this Quick Start by renaming `PROJECT_README_TEMPLATE.md` to `README.md`:
-  
-5. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). 
+[How It Works](#how-this-codebase-achieves-its-objectives) | [Project Architecture](#architecture) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Contact](#contact)
 
-That's it! Your project documentation scafolding is now set up and your documentation site is now live!
 
+## 🧭 How It Works
+> [!IMPORTANT]Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
 
-## Contributing
+#### Architecture
 
-Feel free to contribute, to get started check out our [CONTRIBUTING.md](./CONTRIBUTING.md) guide
+> [!IMPORTANT] Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
 
-## Licensing and Attribution
+#### Key Features
 
-This repository is licensed under the [MIT License][MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
+> [!IMPORTANT] Replace this with a brief explaination of the main features or functionalities of your project.]
 
-The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows][starter workflows]. A copy of their MIT License is available in [actions/starter-workflows][actions/starter-workflows].
+
+## :arrow_heading_down: Installation
+> [!IMPORTANT] Replace with Step-by-step instructions on how to install the codebase. 
+
+## ▶️ How to Run
+> [!IMPORTANT] Replace with clear, concise instructions on how to run and use the codebase.
+
+#### Examples
+
+> [!IMPORTANT] Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
 
 ---
 
-[Jekyll]: https://jekyllrb.com
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[Bundler]: https://bundler.io
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
-[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
-[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
-[MIT License]: https://en.wikipedia.org/wiki/MIT_License
-[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
-[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
+*This project is licensed under the terms of the [LICENSE.md](LICENSE.md) | For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md) | Contact: [maintainer usernames]()*
+
+

From e929b69f4098cb52a09ec3bcca5f44220287de03 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 5 Nov 2024 15:48:42 +0100
Subject: [PATCH 11/13] Fixed wrong rendering and abandoned the purple template
 text

---
 MAINTAINERS.md                                | 39 +++++++++++++++++++
 ...ING.md => PROJECT_CONTRIBUTING_TEMPLATE.md | 13 +++----
 README.md                                     | 21 +++++-----
 3 files changed, 56 insertions(+), 17 deletions(-)
 create mode 100644 MAINTAINERS.md
 rename CONTRIBUTING.md => PROJECT_CONTRIBUTING_TEMPLATE.md (94%)

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
new file mode 100644
index 0000000..ca1178e
--- /dev/null
+++ b/MAINTAINERS.md
@@ -0,0 +1,39 @@
+# Maintainers
+
+This document provides information about the maintainers of the project, their roles, and how to engage with them.
+
+## Current Maintainers
+
+| Name            | GitHub Username      | Role/Responsibilities                   | Contact Method          |
+|-----------------|----------------------|-----------------------------------------|-------------------------|
+| [Maintainer 1]  | [@username1](https://github.com/username1) | [Role/Responsibility]                  | [email@example.com]     |
+| [Maintainer 2]  | [@username2](https://github.com/username2) | [Role/Responsibility]                  | [email@example.com]     |
+| [Maintainer 3]  | [@username3](https://github.com/username3) | [Role/Responsibility]                  | [email@example.com]     |
+
+## Emeritus Maintainers
+
+| Name            | GitHub Username      | Role/Responsibilities                   | Contact Method          |
+|-----------------|----------------------|-----------------------------------------|-------------------------|
+| [Emeritus 1]    | [@emeritus1](https://github.com/emeritus1) | [Previous Role/Responsibility]         | [email@example.com]     |
+
+## Becoming a Maintainer
+
+To become a maintainer of this project, please follow these steps:
+
+1. **Contribute**: Actively contribute to the project by submitting pull requests and participating in discussions.
+2. **Engagement**: Engage with the community and maintainers through issues and discussions.
+3. **Request**: Once you feel ready, request maintainer status by opening an issue or contacting an existing maintainer.
+
+## Removal Process
+
+Maintainers may be removed or moved to emeritus status under the following circumstances:
+
+- Inactivity for an extended period (e.g., 6 months).
+- Failure to respond to issues or pull requests.
+- Request for removal by the maintainer.
+
+Maintainers can be removed through a consensus among current maintainers.
+
+---
+
+*For any questions or concerns regarding maintainership, please reach out to any of the current maintainers listed above.*
diff --git a/CONTRIBUTING.md b/PROJECT_CONTRIBUTING_TEMPLATE.md
similarity index 94%
rename from CONTRIBUTING.md
rename to PROJECT_CONTRIBUTING_TEMPLATE.md
index 1311ece..5a63597 100644
--- a/CONTRIBUTING.md
+++ b/PROJECT_CONTRIBUTING_TEMPLATE.md
@@ -4,21 +4,20 @@ Contributors to the documentation can be project managers, technical editors, de
 
 To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of [Docs As Code](https://openpracticelibrary.com/practice/docs-as-code/) and the open [Markdown](https://en.wikipedia.org/wiki/Markdown) format for ease of collaboration and quality control.
 
-To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/). 
-<br>
-<br>
+To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/).
+`<br>`
+`<br>`
 
 ## 🚀 Quick start
 
 1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information.
 2. Follow the criteria from [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html), [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) and [Document codebase Maturity]()
-in one or several text documents using the Markdown format.
+   in one or several text documents using the Markdown format.
 3. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
 4. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
 5. Collaborate on documentation branches with issues assigned to you by the maintainers.
 
 > 📚 Read more about:
-> 
-> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation  
+>
+> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation
 > How [Just the Docs](https://just-the-docs.github.io/just-the-docs/) is used to generate a documentation site from your markdown files.
-
diff --git a/README.md b/README.md
index 36cb1de..0d1734e 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,42 @@
-> [!WARNING] Remove this section from your README.md after completing all setup tasks!
+> [!WARNING] 
+> *Remove this section from your README.md after completing all setup tasks!*
 > - [ ] Click the green "Use this template" button above.
 > - [ ] Name your new repository and create it.
-> - [ ] Replace all the purple placeholder texts with your project-specific information.
+> - [ ] Replace all the grey placeholder texts with your project-specific information.
 > - [ ] Add any additional relevant Markdown documents to your documentation.
 > - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
 > - [ ] **Remove this setup section from your README.md.**
 >
-> That's it! You are now set up, and your documentation site is live!
+> *That's it! You are now set up, and your documentation site is live!*
 
 
 # [Replace with Project Title]
-> [!IMPORTANT] [Replace with a clear statement defining the mission and goals of your project in simple terms.]
+> Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
 
 [How It Works](#how-this-codebase-achieves-its-objectives) | [Project Architecture](#architecture) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Contact](#contact)
 
 
 ## 🧭 How It Works
-> [!IMPORTANT]Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
+> Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
 
 #### Architecture
 
-> [!IMPORTANT] Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
+> Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
 
 #### Key Features
 
-> [!IMPORTANT] Replace this with a brief explaination of the main features or functionalities of your project.]
+> Replace this with a brief explaination of the main features or functionalities of your project.]
 
 
 ## :arrow_heading_down: Installation
-> [!IMPORTANT] Replace with Step-by-step instructions on how to install the codebase. 
+> Replace with Step-by-step instructions on how to install the codebase. 
 
 ## ▶️ How to Run
-> [!IMPORTANT] Replace with clear, concise instructions on how to run and use the codebase.
+> Replace with clear, concise instructions on how to run and use the codebase.
 
 #### Examples
 
-> [!IMPORTANT] Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
+> Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
 
 ---
 

From f379a20e8781abac07a93d9e7102b162f47e1373 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 6 Nov 2024 09:40:16 +0100
Subject: [PATCH 12/13] Merged the Install and Run sections into one

---
 README.md | 10 +++-------
 1 file changed, 3 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 0d1734e..5b5d654 100644
--- a/README.md
+++ b/README.md
@@ -21,18 +21,14 @@
 
 #### Architecture
 
-> Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram e.g. in mermaid syntax
+> Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram preferably in mermaid syntax.
 
 #### Key Features
 
 > Replace this with a brief explaination of the main features or functionalities of your project.]
 
-
-## :arrow_heading_down: Installation
-> Replace with Step-by-step instructions on how to install the codebase. 
-
-## ▶️ How to Run
-> Replace with clear, concise instructions on how to run and use the codebase.
+## ▶️ How to Install and Run
+> Replace with clear, concise instructions on how to install and run the codebase for development, test and production setups. Link to repositories containing deployment templates that automates deployment
 
 #### Examples
 

From 9c29c58a22e9d00c3d4de69380e6a1a9efa80265 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 6 Nov 2024 09:51:28 +0100
Subject: [PATCH 13/13] Fixed the anchor links

---
 README.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 5b5d654..451fa61 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-> [!WARNING] 
+> [!IMPORTANT] 
 > *Remove this section from your README.md after completing all setup tasks!*
 > - [ ] Click the green "Use this template" button above.
 > - [ ] Name your new repository and create it.
@@ -13,15 +13,15 @@
 # [Replace with Project Title]
 > Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
 
-[How It Works](#how-this-codebase-achieves-its-objectives) | [Project Architecture](#architecture) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) | [License](#license) | [Contact](#contact)
-
+[How It Works](#🧭-how-it-works) | [Architecture](#architecture) | [ How to Install and Run](#▶️-how-to-install-and-run)
 
 ## 🧭 How It Works
 > Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
 
 #### Architecture
 
-> Replace with a Brief introduction to the project's high-level architecture. Link to an ARCHITECTURE.MD diagram preferably in mermaid syntax.
+> Replace with a Brief introduction to the project's high-level architecture. Link to the architecture documentation with a diagram preferably in mermaid syntax.
+[ARCHITECTURE.MD](./docs/ARCHITECTURE.MD)
 
 #### Key Features