agent-ready-repo / guides
AGENTS.md27 starsChanged yesterdayApache-2.0View on GitHub
Applies to guides/. Inherits the root AGENTS.md. Scope-specific deltas only. guides/ is adopter-facing; docs/guides/ is maintainer material. This tree is published by tools/build-site.py: writing a valid file is all publication and navigation require. Use the author-product-docs skill for authoring work. contracts/guide.schema.json owns frontmatter; additionalProperties: false means new fields belong there first. Keep title and the leading body H1 identical: _shared guides ship without rendered frontmatter, so no H1 leaves adopters without a page heading. When deleting or renaming a page,…
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 18
When deleting or renaming a page, delete its guide-nav-baseline.toml entry in the same change.
- Very specific: line 21
Prefer in-tree link targets: links out of guides/ render as GitHub blob URLs and send readers off-site.
- Distinctive: line 34
No callouts; a table only to compare options.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md — guides/
Applies to guides/. Inherits the root AGENTS.md. Scope-specific deltas only.
Audience and publication
guides/ is adopter-facing; docs/guides/ is maintainer material. This tree is
published by tools/build-site.py: writing a valid file is all publication and
navigation require. Use the author-product-docs skill for authoring work.
Content traps
contracts/guide.schema.json owns frontmatter;
additionalProperties: false means new fields belong there first. Keep title
and the leading body H1 identical: _shared guides ship without rendered
frontmatter, so no H1 leaves adopters without a page heading.
When deleting or renaming a page, delete its guide-nav-baseline.toml entry in
the same change. The nav-ineligible set is pinned by its inventory test.
- Prefer in-tree link targets: links out of
guides/render as GitHub blob URLs and send readers off-site.
Job pages
A page the docs sidebar lists is a job page. The CLI tab pages are the model.
- Open with one sentence on what the reader can do. No subtitle, no history.
- Each section: a lead-in sentence ending in a colon, one command or prompt, then one sentence on what happens. Put choices and decisions in prose.
- Say which packs the job needs and how to install them; never assume
core. - Explain a file or term where the reader first acts on it, in plain words.
- Flags, environment variables, edge cases, and errors go to a reference page.
- No callouts; a table only to compare options. About 150–400 words.
- No "Step N" in headings: verb-phrase H2s in reading order, H3 for sub-parts.
- Name no agent host outside the supported agents (no Conductor, Orca, etc.).
Essential commands
python3 tools/validate_guides.py
python3 tools/check-guide-index.py
python3 tools/lint-guide-titles.py
python3 tools/build-site.pyDeeper pointers
site.toml and tools/build-site.py own navigation and projection details. For
rendered checks, follow docs-site/AGENTS.md § Build.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository75 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- docs-site/AGENTS.mdAGENTS.md
- packages/AGENTS.mdAGENTS.md
- packs/AGENTS.mdAGENTS.md
- profiles/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- tools/AGENTS.mdAGENTS.md
- web/AGENTS.mdAGENTS.md
- docs/CLAUDE.mdCLAUDE.md
- guides/CLAUDE.mdCLAUDE.md
- packages/CLAUDE.mdCLAUDE.md
- packs/CLAUDE.mdCLAUDE.md
- profiles/CLAUDE.mdCLAUDE.md
- tests/CLAUDE.mdCLAUDE.md
- tools/CLAUDE.mdCLAUDE.md
- llms.txtllms.txt
- adapt-to-projectSkill
- assimilate-primitiveSkill
- assimilate-repoSkill
- author-briefSkill
- author-delivery-briefSkill
- author-product-docsSkill
- bug-fixSkill
- close-workSkill
- compile-okfSkill
- contract-acquisitionSkill
- explain-diffSkill
- init-projectSkill
- intake-intentSkill
- navigate-decisionsSkill
- navigate-intentsSkill
- new-adrSkill
- new-rfcSkill
- new-specSkill
- operational-safetySkill
- project-knowledgeSkill
- propose-catalogue-packSkill
- receive-briefSkill
- repository-explorationSkill
- repository-groundingSkill
- security-checklists-referenceSkill
- security-checklistsSkill
- work-intakeSkill
- work-loopSkill
- workspace-statusSkill
- adapt-to-projectSkill
- assimilate-primitiveSkill
- assimilate-repoSkill
- author-briefSkill
- author-delivery-briefSkill
- author-product-docsSkill
- bug-fixSkill
- close-workSkill
- compile-okfSkill
- contract-acquisitionSkill
- explain-diffSkill
- init-projectSkill
- intake-intentSkill
- navigate-decisionsSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.