TransitMatters Labs Docs

Onboarding docs and architecture diagrams for TransitMatters Labs volunteers.

Read them at https://transitmatters.github.io/architecture/

Editing

Pages are Markdown in docs/. Diagrams are Mermaid code blocks inside those pages, so they render on GitHub too:

```mermaid
flowchart LR
    v3(["MBTA V3 API"]) --> app["Your app"] --> site("your-site.transitmatters.org")
```

Shape conventions are on the architecture overview. The Mermaid Live Editor is handy for trying out changes.

Running locally

Requires uv.

uv sync
uv run mkdocs serve

Then open http://127.0.0.1:8000.

Deploying

Merging to main publishes the site to GitHub Pages via .github/workflows/docs.yml. PRs run a strict build, so broken links fail CI.