Documentation Home¶
This site documents the project so someone new can understand it quickly and operate it safely.
How to use these docs¶
- Start with Project Map to understand the repo structure and major systems.
- Use Architecture to understand how the pieces fit together.
- Use Flows to understand how specific user actions work end-to-end.
- Use Deployment for build/hosting notes.
- Use Runbooks for operational procedures.
- Use ADR to capture why important decisions were made.
Documentation standards¶
- Prefer verified statements (point to code files / SQL migrations).
- If something is uncertain, label it as Inferred and move details to the Discovery Log.
Next: