Architecture Decision Records

This section demos how to record and summarise Architecture Decision Records (ADRs) using the MkDocs Material tags in-built plugin.

You'll need to add a tag keyword to the front-matter and specify the ADR status for example:

---
tags: 
    - Proposed
---

I have associated icons with the ADR status tags on the mkdocs.yml file.

I have modified the background colors for the ADR status tags by adding a separate style sheet.

The tags plugin will automatically include all markdown files in the docs repository with a tags keyword. This is great because it means you don't have to list the individual ADRs in the nav section of the mkdocs.yml file. However it also means you cannot use non ADR-status tags, unless you use mkdocs material Insiders with scoped tags indexes.

Accepted

• 0002: Demo Architecture Decision Record
• 0007: Demo Architecture Decision Record

Deprecated

• 0009: Demo Architecture Decision Record

Draft

• 0001: Demo Architecture Decision Record
• 0003: Demo Architecture Decision Record
• 0005: Demo Architecture Decision Record

Proposed

• 0004: Demo Architecture Decision Record
• 0010: Demo Architecture Decision Record

Rejected

• 0008: Demo Architecture Decision Record

Superseded

• 0006: Demo Architecture Decision Record