update-docs

Prompt file imported from coder-2011/no-circles (.codex/prompts/update-docs.md). Copyright stays with the author.

/update-docs

Update project documentation to match current code and architecture decisions.

Goal:

• Keep documentation in sync with implementation.
• Maintain required structure:
  • documentation/subsystems/
  • documentation/files/
  • documentation/appendix/

Required workflow:

1. Inspect current branch and working tree:
   • git branch --show-current
   • git status --short
2. Review changed files and diffs:
   • git diff --name-only
   • git diff --cached --name-only
   • git diff
3. Update subsystem docs:
   • Ensure each active subsystem has/updates a doc under documentation/subsystems/.
4. Update file docs:
   • For each created/modified code file, create/update corresponding docs under documentation/files/.
5. Update appendix docs:
   • Add/update key terms and concepts in documentation/appendix/ when new vocabulary appears.
6. Keep top-level docs aligned:
   • Reconcile updates with documentation/vision.md and documentation/architecture.md.
7. Validate documentation index:
   • Ensure documentation/README.md reflects new/updated docs and reading order.
8. Return a concise summary:
   • files created/updated
   • any missing docs still pending
   • suggested next documentation actions

Constraints:

• Do not switch branches.
• Do not amend commits.
• Do not delete docs unless explicitly justified by a code removal.
• Prefer concise, implementation-aligned documentation over speculative content.