Documentation Map
This repository-level documentation is intentionally organized by platform concern.
On this page ▾
text
docs/
├── api/
├── architecture/
├── assets/
├── deployment/
├── infra/
├── runbooks/
├── user-guide/
└── Misc/Why App Documentation Is Excluded
Individual Django applications already have dedicated documentation.
Platform documentation should explain:
- how the whole system fits together
- deployment
- operations
- security
- integrations
- API contracts
- developer workflows
without duplicating every application's internal model/service reference.
Maintenance
When an app's internals change, update its app documentation.
When a cross-cutting contract changes, update the appropriate platform document here.
Something wrong or missing on this page?Report a docs issue