For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /packs/shared/documentation/guides.md.
Quick start

Guides

A guide helps a reader complete one task they already understand. Put options and background in linked reference and concept pages.

Task contract

Why

Installing selected content and authoring a definition are separate tasks. Combining them makes prerequisites and completion criteria unclear.

Rules

  • MUST start the title with an action verb and name the result. [review]
  • MUST state the working directory, supported runtime, required tools, and initial state in Prerequisites. [review]
  • MUST number the actions in execution order. [review]
  • MUST include complete commands when the reader is expected to execute them. [review]
  • MUST give Verification an observable command result or filesystem outcome. [review]
  • MUST include Troubleshooting for known failure modes and link detailed diagnoses instead of duplicating them. [review]
  • MUST finish with Next steps that continue the same reader journey. [review]
  • SHOULD keep optional variations after the primary task, with reference links for their contracts. [review]

Example structure

The example assumes a Granary source checkout and a fresh consumer configuration.

# Install the standards pack

Install the checked-in engineering rules as ordinary files.

## Prerequisites

- Run from the Granary repository root.
- Use Node.js 26+ and the pinned pnpm version.
- Install into a fresh consumer directory.

## 1. Inspect the source

```sh
pnpm cli add . --list
```

## 2. Install docs

```sh
CONSUMER="$(mktemp -d)"
pnpm cli add "$PWD" --pack recommended-typescript --cwd "$CONSUMER"
```

## Verification

```sh
pnpm cli list --cwd "$CONSUMER"
```

Expect the standards identity and a `docs` group. Follow its reference link in root `AGENTS.md`.

## Troubleshooting

If the pack already exists, restore it with `pnpm cli install --cwd "$CONSUMER"` rather than adding it twice.

## Next steps

Point the agent at the installed entrypoint before starting a code change.

[review]

Component-content tests check standard metadata and heading structure. Guide prerequisites, numbered actions, required task sections, and command correctness require review and execution of the primary path.

See Formatting, References, and Troubleshooting.

Enforcement

Component-content tests check standard metadata and heading structure. Guide prerequisites, numbered actions, required task sections, and command correctness require review and execution of the primary path.

See Formatting, References, and Troubleshooting.