djangoplay-web / Misc / Documentation Map
DocsDjangoPlay WebMiscDocumentation Map

Documentation Map

This repository-level documentation is intentionally organized by platform concern.

1 min readApplies to v1.2.2
On this page ▾
  1. Why App Documentation Is Excluded
  2. Maintenance
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.