FAQ¶

Should a topic exist in multiple pages?¶

No. Keep one canonical page per topic and link to it from other pages.

Where do new docs belong?¶

• workflow and lifecycle content: top-level docs pages
• capability explanation: docs/capabilities/
• lookup/mapping content: docs/reference/

How should deployment commands be written?¶

Use explicit deploy compose invocation:

docker compose -f docker-compose-deploy.yml ...

Avoid hardcoding environment-specific service aliases in generic docs.

What must be updated when new domain module is added?¶

• docs/domain-apps.md
• docs/capabilities/module-capability-matrix.md
• docs/reference/url-map.md
• mkdocs.yml nav if a new page is introduced

What is the fastest way to troubleshoot docs drift?¶

1. compare routes in app/app/urls.py against reference/url-map.md
2. compare installed apps in app/app/settings.py against module/capability pages
3. verify compose/service docs against compose files