Architecture

Architecture Documentation

This section houses architectural diagrams and documentation that describe how Train.md is structured.

Primary Model: C4

We use the C4 model to document architecture at multiple abstraction levels:

Context → Container → Component → Code
   ↑          ↑            ↑          ↑
  Zoom out                        Zoom in
LevelShowsAudience
L1 ContextSystem in its environmentEveryone
L2 ContainerHigh-level technical building blocksTechnical stakeholders
L3 ComponentInternal structure of containersDevelopers

Diagram Format

All diagrams are stored as Mermaid or PlantUML code blocks, enabling:

  • Version control alongside code
  • Easy updates without external tools
  • Automated rendering in the documentation site

Getting Started

Explore the C4 Model section for templates and examples at each level.