Documentation
README
Maintain agent guidance
Use this skill when the root or nested AGENTS.md tree may have drifted,
grown, or started constraining agents unnecessarily. The goal is not to
document the whole repository. It is to keep inherited context small,
durable, and useful at every scope.
Place context deliberately
Before adding guidance, classify it:
| Destination | Admission test |
|---|---|
Root AGENTS.md |
Broadly applicable, non-obvious, durable, and costly when missed |
Scoped AGENTS.md |
The same, but limited to one subtree |
| Skill | A workflow loaded for a recognizable task |
| Existing docs or source | Detailed reference material or implementation truth |
| Nowhere | Generic advice or facts an agent can discover cheaply |
This is the opening of the README. Read the full README on GitHub.