Documentation site map
This page is the coverage index for the public VitePress site. If something is listed here, it is intended to be maintained as part of the docs product. If you add a new top-level section, update this file and the navigation in .vitepress/config.mjs.
How to read this site
| Audience | Start here |
|---|---|
| New engineers | Engineering onboarding, Conventions |
| Day-to-day development | Tools quickstart, Tooling reference |
| Architecture | Architecture hub |
| Operations | Operations hub (SLOs) and Runbooks |
| Product engineering process | Projects hub (RFCs and retrospectives) |
Top-level sections
Home (/)
Marketing-style landing for the docs site with shortcuts into Tools, Wiki, and Ops.
Tools (/tools/)
Local workflows, scripts, troubleshooting, and canonical workflow inventory for repository automation.
- Tools overview
- Quickstart
- Tooling reference — scripts, GitHub Actions paths, and where to find release/deploy truth
- Troubleshooting
Wiki (/wiki/)
Team knowledge: onboarding, conventions, architecture deep dives, and ADRs.
- Onboarding
- Conventions
- Architecture hub
- ADRs (see sidebar for full list)
Ops (/ops/)
SLOs, runbooks, and postmortems.
Projects (/projects/)
Cross-team engineering process: RFCs and retrospectives.
Internal planning markdown (not published here)
Implementation plans and agent workflow notes may live under docs/plans/ in the git repository, but they are excluded from the public VitePress build and routed to 404 on the public docs site. Read them in GitHub when you need historical planning context.
For release behavior, deployment gates, and CI ownership, treat Tooling reference and AGENTS.md (repository root) as complementary sources of truth—AGENTS.md is optimized for agents and contributors working from the repo checkout.