Agent Page Contract

To keep docs reliably consumable by agents, every task page should follow this schema.

Human-oriented docs (site pages)

Core entry pages on this site use a compact shape that maps to the machine schema below:

Section	Role
Purpose	Why open this page
Prerequisites	Environment and prior steps
Steps	Ordered actions
Verify	How to confirm success
If it fails	Recovery; link to Troubleshooting when useful

Required sections

Prerequisites
Inputs
Command/API
Expected Result
Failure Modes
Retry Policy
Next Step

URL and heading rules

One task per page.
Stable, descriptive slugs.
No duplicate headings in the same page.
Avoid vague titles like Tips or More.

Command block rules

Use fenced bash blocks for shell commands.
Put one primary command per block.
Provide deterministic expected output statements.
Include recovery command when possible.

Error handling rules

Refer to stable error code identifiers.
Include retryability (yes/no/maybe).
Include one concrete recovery action.

Machine-readable outputs

/llms.txt: concise index of docs routes.
/llms-full.txt: expanded corpus for retrieval and offline indexing.