Updating Documentation¶
Documentation must be updated with each user-facing change.
Every new tool, workflow, CLI command, or CLI flag must update:
README.mdif the feature is user-facing.docs/tools.mdif a tool or agent wrapper changes.docs/workflows.mdif a workflow changes.docs/cli_usage.mdif a command, option, or output file changes.docs/configuration.mdif an environment variable or external binary path changes.docs/examples.mdif a new use case becomes possible.- Tests that establish the documented behavior.
Also update:
docs/agent_usage.mdfor planning, agent, profile, LangGraph, or reporting behavior.docs/agapi.mdfor AGAPI backend, model, or materials-query changes.docs/safety.mdwhen execution boundaries or verification behavior changes.docs/roadmap.mdwhen planned work becomes implemented or changes stage.CHANGELOG.mdwhen it exists and the change is release-relevant.
Accuracy Rules¶
- Inspect the source before documenting a command.
- Do not invent commands or output files.
- Mark planned features as planned.
- Keep examples copy-pasteable.
- Never include real API keys or private licensed-software paths.