| Document | What it covers |
|---|---|
| ARCHITECTURE.md | System design, components, data flow |
| INVARIANTS.md | Runtime invariants and safety guarantees |
| RECOVERY_MODEL.md | Failure modes and recovery strategies |
| Document | What it covers |
|---|---|
| INSTALL.md | Directory layout, file locations, manual install |
| FIRST_BOOT.md | First-run setup wizard walkthrough |
| PACKAGING.md | .deb packaging and systemd deployment |
| Document | What it covers |
|---|---|
| CONFIGURATION.md | Bootstrap file, authentication, secrets layout |
| AI_PROVIDERS.md | AI provider setup (OpenAI, Anthropic, Gemini) |
| UI_CONFIGURATION.md | UI configuration reference and routes |
| Document | What it covers |
|---|---|
| RUNBOOK.md | Day-to-day operations |
| CUTOVER.md | Production cutover procedure |
| SHADOW_MODE.md | Shadow mode operation |
| Document | What it covers |
|---|---|
| SECURITY_MODEL.md | Overall security model |
| SECRET_LOADING_MODEL.md | Canonical secret paths and loading chain |
| TRUSTED_NETWORKS.md | Protected ASN/CIDR classification |
| UI_SECURITY.md | UI authentication security |
| Document | What it covers |
|---|---|
| TESTING.md | Test strategy and coverage |
| COVERAGE_POLICY.md | Coverage requirements |
| Document | What it covers |
|---|---|
| RELEASE_CHECKLIST.md | Pre-release gate checklist |
| Document | What it covers |
|---|---|
| PYTHON_LEGACY_SUMMARY.md | Python legacy summary and migration notes |