project-docs
Installation
SKILL.md
Project Docs
This skill helps you keep documentation correct, minimal, and aligned with the codebase.
What To Document
- User-facing behavior changes
- New CLI flags, environment variables, configuration changes
- Protocol/API changes, request/response shapes
- Operational guidance (troubleshooting, limitations, safety workflows)
Doc Update Workflow
- Identify the code changes and their user-visible effects.
- Locate the canonical docs (README vs guides vs references).
- Update docs with minimal churn, matching existing style.
- Cross-check examples against current CLI help / code.
- Run relevant tests and include them in the update note.