ADRs

Architecture Decision Records

This section contains all ADRs for Train.md.

Naming Convention

NNNN-short-kebab-title.md

Examples:

  • 0001-adr-template.md
  • 0002-use-hugo-book-theme.md
  • 0003-mermaid-for-diagrams.md

Creating a New ADR

  1. Copy the ADR template
  2. Increment the number (0002, 0003, etc.)
  3. Fill in all sections
  4. Submit for review
  5. Update status once decided

ADR Index

#TitleStatusDate
0001ADR TemplateTemplate—

Tip: Keep ADRs short (1-2 pages). If it’s getting long, consider splitting into multiple decisions.

ADR-0001: Template