Architecture Decision Records (ADRs)¶
This directory documents the significant architectural, design, and structural decisions made in Swayrm.
Record Format¶
Based on Michael Nygard's ADR format:
- Title:
NNNN-short-descriptive-title.md - Status:
Proposed|Accepted|Deprecated|Superseded - Context: What is the context, problem, or force driving this decision?
- Decision: What choice was made?
- Consequences: What becomes easier or more difficult as a result?
Decision Index¶
- ADR-0001: Record Architecture Decisions and Maintain Strict Repository Containment —
Accepted - ADR-0002: Continuous Documentation Publishing and Public Evolution via Material for MkDocs on GitLab Pages —
Accepted - ADR-0003: Merge Request Workflow and Dedicated Worktrees per Increment —
Accepted - ADR-0004: Documentation Portal Aesthetics and Design System Overhaul —
Accepted - ADR-0005: Visual Identity and Emblem Logo Integration —
Accepted - ADR-0006: Streamlined Decision Indexing and List Navigation —
Accepted