Imported from kenny2077/Aurora (
docs/AGENTS.md). Install upstream withnpx skills add kenny2077/Aurora --skill docs. Copyright stays with the author.
docs/AGENTS.md
Scope: this file governs documentation changes under docs/.
Documentation Style
- Be concise and concrete.
- Prefer examples, short checklists, and small tables when they reduce ambiguity.
- Do not write marketing filler.
- Do not create duplicate docs.
- Update existing docs before adding new docs.
- Keep commands exact and runnable from the repository root unless stated otherwise.
Required Updates
Update documentation when changing:
- setup commands
- CLI commands or flags
- environment variables or secrets
- configuration schema/defaults
- architecture or pipeline behavior
- provider/source adapter behavior
- testing or validation workflow
- GitHub Actions, Pages, email, or delivery behavior
Forbidden
- Do not invent roadmap commitments.
- Do not mark features as complete unless verified.
- Do not create status reports, summaries, or new planning docs unless the user asks for them.
- Do not copy content from reference projects wholesale.