Merge pull request #7 from MinBZK/adr/documentation

An ADR to propose using ADRs

docs/ADRs/0001-adrs.md

@@ -0,0 +1,43 @@
+---
+title: 0001 ADRs
+adr:
+  author: Anne Schuth
+  created: 16-Feb-2024
+  status: proposed
+---
+
+## Context
+
+In modern software development practices, the use of Architecture Decision Records (ADRs) has become increasingly
+common. ADRs are documents that capture important architectural decisions made during the development process. These
+decisions play a crucial role in guiding the development team and ensuring consistency and coherence in the architecture
+of the software system.
+
+## Assumptions
+
+1. ADRs provide a structured way to document and communicate architectural decisions.
+2. Publishing ADRs publicly fosters transparency and facilitates collaboration among team members and stakeholders.
+3. ADRs help in onboarding new team members by providing insights into past decisions and their rationale.
+
+## Decision
+
+We will utilize ADRs in our team to document and communicate architectural decisions effectively. Furthermore, we
+will publish these ADRs publicly to promote transparency and facilitate collaboration.
+
+
+## Template
+Use the template below to add an ADR:
+
+```yaml
+---
+    title: 0004 Title
+    adr:
+        author: Jean-Loup Monnier
+        created: 01-Aug-2023
+        status:  draft | proposed | rejected | accepted | superseded
+        superseded_by: 0001-test
+        extends:
+            - 0001-first
+            - 0002-second
+---
+```

mkdocs.yml

@@ -5,31 +5,26 @@ site_description: Documenting the processes of the AI Validation Team at the Min
 
 ### theme settings ###
 theme:
-    name: material
+    name: mkdocs-material-adr
     language: en
     palette:
-        primary: blue
+        primary: deep orange
+        scheme: slate
     features:
         - navigation.indexes
         - navigation.tabs
         - navigation.tabs.sticky
         - navigation.path
         - navigation.top
         - navigation.tracking
-        # - navigation.footer
+        - navigation.instant
         - search.highlight
         - search.suggest
         - content.action.edit
     icon:
         logo: fontawesome/solid/house
         annotation: fontawesome/solid/circle-info
 
-# Navigation for the site
-nav:
-    - Home: index.md
-    - Way of Working:
-        - wow/principles.md
-
 markdown_extensions:
     - pymdownx.tabbed:
         alternate_style: true
@@ -55,6 +50,7 @@ extra:
 
 
 plugins:
+    - mkdocs-material-adr/adr
     - glightbox
     - search
     - git-revision-date-localized:

requirements.txt

@@ -1,7 +1,8 @@
-mkdocs==1.5.3
+Jinja2>=2.11.1
 mkdocs-git-revision-date-localized-plugin==1.2.2
 mkdocs-glightbox==0.3.6
-mkdocs-material==9.5.4
+mkdocs-material-adr==1.1.0
 mkdocs-material-extensions==1.3.1
+mkdocs-material==9.5.4
+mkdocs==1.5.3
 pymdown-extensions==10.7
-Jinja2>=2.11.1