apply patch "0001-fixup-some-formulations.patch"

docs/concepts-and-configurations/documentation-structure.md

@@ -7,14 +7,14 @@ summary: >-
 
 !!! info "Info"
 
-    If youre looking for a hands-on approach on how documentation is to be written you can find a [guide](../guides/writing-documentation.md) explaining the process. If youre unsure how to start you can find [templates](../guides/writing-documentation.md#3-addedit-your-markdown-file) there aswell. 
+    If youre looking for a hands-on approach on how documentation is to be written you can find a [guide](../guides/writing-documentation.md) explaining the process. If you're unsure how to start you can find [templates](../guides/writing-documentation.md#3-addedit-your-markdown-file) there aswell. 
 
 ## General Rules
-Rules are formatting and writing decisions that apply to every document. Their goal is to provide a concise style across the whole documentation to keep the text easy to follow.
+These rules are general formatting and writing decisions that apply to every document. Their goal is to provide a concise style across the whole documentation to keep the text easy to follow.
 
 - All documents written in this project should be written in **english** to maximize the compatability across readers.
 - The documentation structure is intended to be followed, while not being **enforced** to keep a low entry barier for documentation authors.
-- Use features like _Admonitions_ given by markdown and the theme whenever they can help by increasing the readability and outlining important parts. For instructions on how to use these theme specific features please refer down to the _MkDocs shadcn_ documentation in the References section.
+- Use features like _Admonitions_ given by markdown and the theme whenever they can help by increasing the readability and outlining important parts. For instructions on how to use these theme specific features please refer down to the [MkDocs shadcn](https://asiffer.github.io/mkdocs-shadcn/) documentation.
 
 ## Defining a Document Scope
 The scope for a document should be set to define responsibility and set boundaries to where that document applies. Especially lining out which services are affected by it. It **does not** need to be defined explicitly in the text, but should be kept in mind while writing.
@@ -23,11 +23,11 @@ The scope for a document should be set to define responsibility and set boundari
   
     The scope for this document is aiming to convey the base concepts on how to structure concepts and configurations in this documentation. To provide high readability and a project wide concise structure that authors and readers can rely on.
 
-We decide in this documentation between concepts, configurations and guides. Their separation should be clearified with folowing list:
+We generally distinguish between concepts, configurations and guides in this documentation. Their separation should be clarified with folowing list:
 
-- **Concept:** A concept includes an abstract definition about a specific structure while not going into implementation details.
+- **Concept:** A concept includes an abstract definition about a specific structure while not going into implementation details. It is a document intending to further the abstract understanding of structure. It can also go into detail about _why_ we do things a certain way.
 - **Configuration:** A configuration can be a follow up of a concept, explaining the specific implementation in a given environment.
-- **Guide:** A guide is a step-by-step hands-on instruction for the reader to follow along. It can reference concepts and configurations.
+- **Guide:** A guide is a step-by-step hands-on instruction for the reader to follow along. It can reference concepts and configurations. The important difference to the other two document types is that guides are goal oriented. Understanding how things work is secondary to achieving a specific thing.
 
 
 ## Structuring Concepts 
@@ -44,7 +44,7 @@ This section is a summary to give the reader a quick overview about the concept
 - What does this concept do?
 
 ### Explaining the Concept
-This section should be an in depth explanation about the concept, explaining the concept as detailed as needed for the reader to be able to transfer it into an implementation. The usage of graphs and diagrams is advised when they can help the reader to understand the concept better.
+This section should be an in depth explanation about the concept, explaining the concept as detailed as needed for the reader to be able to transfer it into an implementation. The usage of graphs and diagrams is advised when they can help the reader understand the concept better.
 
 ### Referencing additional Sources
 This section should include sources to other documentations, concepts and hand-on guides which the reader can look up to futher explore the defined concept. 
@@ -60,7 +60,7 @@ This section should include sources to other documentations, concepts and hand-o
 This section should give the reader a quick overview which configuration files are being described.
 
 ### Providing the Configuration
-Here should the author provide configuration sections or full templates. The configurations don't have to be fully complete, theyre rather a more structured view on which options are important and what to watch out for.
+Here the author should provide configuration sections or full templates. The configurations don't have to be fully complete, they're rather a more structured view on which options are important and what to watch out for.
 
 ### Discussing Authors Thoughts
 A discussion why the author choose which configuration options and what to watch out for. Best practices should be taught here. This section can also link to outside sources.
@@ -69,7 +69,7 @@ A discussion why the author choose which configuration options and what to watch
 Here the author should provide upstream documentation which includes configuration options and further explanations why and how they are used.  
 
 
-## Structuring Guide
+## Structuring Guides
 
 !!! note "Goal"
 
@@ -78,15 +78,27 @@ Here the author should provide upstream documentation which includes configurati
 ### Defining the Goal 
 A guide should always have a goal defined in the beginning, using the _Admonition_ for a success box is highly advised. An example for a goal box is shown below:
 
+/// tab | Source
+
 ```markdown
 !!! success "Goal"
-    How to setup, write its baseline documentation in ansible and deploy a service. 
+    How to setup, write its baseline documentation in ansible, and deploy a service. 
 ```
+
+///
+
+/// tab | Rendered
+
+!!! success "Goal"
+    How to setup, write its baseline documentation in ansible, and deploy a service.
+
+///
+
 ### Instructing the Reader 
 A guide should always have numbered instruction steps which are easy to follow. Important notices and information should written in _Admonitions_ as direct notices from the author to the reader. Dangerous steps or options should use a `danger` Admonition.
 
 ### Closing Up
-A guide should be finished with steps and facts that can be checked by the reader to ensure that the guide worked as intended and all steps are completed correctly.
+While this section is optional, a guide should be finished with steps and facts that can be checked by the reader to ensure that the guide worked as intended and all steps are completed correctly.
 
 ## References
 Here you can find useful documentation regarding writing documentation:

mkdocs.yml

@@ -9,6 +9,7 @@ markdown_extensions:
   - attr_list
   - codehilite
   - pymdownx.blocks.details
+  - pymdownx.blocks.tab
   - pymdownx.superfences:
       css_class: codehilite