The HTML handbook and machine-readable views come from the same canonical
Markdown and reviewed configuration files. Start at llms.txt
and
fetch only the relevant guides. Every handbook page links to its Markdown view
and declares rel="alternate" type="text/markdown" and rel="describedby".
| Resource | Purpose |
|---|---|
| /llms.txt | Compact discovery index with guide descriptions and downloads |
| /llms-full.txt | Combined Markdown handbook when a complete snapshot is useful |
| /index.md | Homepage Markdown; other guides append .md to their route |
| /setup/index.json | Recipe IDs, required inputs, ordered steps, validation scope and bundle hashes |
| Reference archive | Complete editable directory, README and file checksums |
| Schemas and examples | Exported configuration contracts and source checksums |
The llms.txt convention is a discovery aid. Agents can also follow ordinary links; no JavaScript, private source checkout or browser session is required for this public handbook. Deployments that protect the handbook must apply the same access policy to Markdown, indexes and downloads.
Setup contract#
Select a recipe in the JSON index and read its guide/README before execution. Collect required values from the operator; do not invent credentials, model access, DNS or hardware capacity. Check version/validation metadata, download the matching bundle, verify its archive and file checksums, then edit the explicit input files. Run steps in dependency order and stop on failed checks.
The index describes commands and expected outcomes; it is not a deployment
executor or authorization to modify an installation. validation records what
was actually checked. Compose/YAML validation does not prove credentials,
inference, permissions or user workflows. Report which checks ran and their
results rather than turning an expected HTTP 200 into a claim of success.
Never put real secrets, patient data or private source into logs, generated instructions, repository files or documentation feedback. For an installation task, follow the operator's authorization and preserve existing data and keys.