skills/a0-development/references/dox-workflow.md
/a0/AGENTS.md/a0/skills/AGENTS.md/a0/skills/a0-development/AGENTS.md/a0/skills/a0-development/references/AGENTS.md/a0/api/*.py.dox.md, /a0/tools/*.py.dox.md, /a0/helpers/*.py.dox.mdAGENTS.md.AGENTS.md found on that route.AGENTS.md lists a child whose scope contains the path, read that child and continue.AGENTS.md as the local contract. Parent docs still apply.Do not rely on memory for DOX. Re-read the current files.
Update the nearest owning AGENTS.md when a meaningful change affects:
AGENTS.md file.Update parent docs when parent-level structure or child indexes change. Remove stale or contradictory text rather than explaining old history.
Small implementation edits that do not change contracts may leave DOX unchanged, but still perform the DOX closeout pass and say why docs stayed unchanged.
Do not create or update DOX under ignored usr/ or tmp/ unless explicitly requested.
Some directories require per-file .dox.md companions:
| Directory | Requirement |
|---|---|
api/ | Every direct *.py endpoint or ws_*.py module must have matching *.py.dox.md. |
tools/ | Every direct *.py tool module must have matching *.py.dox.md. |
helpers/ | Many helper modules use file-level DOX; follow helpers/AGENTS.md before changing helper behavior. |
When adding, deleting, renaming, or behaviorally changing one of those files, update the companion DOX in the same change.
git diff --check for whitespace.api/ or tools/.