AGENTS.md@guides · diff
git:20260913.f2b1f5a to git:20261015.e49f8f8
12 added, 7 removed. Audit A to A.
# 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`](../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.
- ## The guidebook step contract
+ ## Job pages
- A guidebook step is a guide page carrying `order:` frontmatter inside a pack's
- guidebook, and every step must carry every obligation the contract enumerates.
- The contract is [`docs/guides/guidebook-step-contract.md`](../docs/guides/guidebook-step-contract.md)
- and `tools/lint-guidebook-steps.py` enforces it, reading its identifiers and
- label forms out of that file.
+ 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
```bash
python3 tools/validate_guides.py
python3 tools/check-guide-index.py
python3 tools/lint-guide-titles.py
- python3 tools/lint-guidebook-steps.py guides/<pack>
python3 tools/build-site.py
```
## Deeper pointers
`site.toml` and `tools/build-site.py` own navigation and projection details. For
rendered checks, follow [`docs-site/AGENTS.md` § Build](../docs-site/AGENTS.md#build).