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/references.md.
Quick start

References

A reference answers a precise contract question. Keep its fields and outcomes accurate even when the reader skips the surrounding prose.

Contract coverage

Why

A CLI option's name does not explain its default or whether the choice is persisted. Schema and command references need those details to prevent incorrect assumptions.

Rules

  • MUST identify whether the surface is implemented, internal-only, released, or proposed. [review]
  • MUST document required inputs, defaults, interpretation bases, and accepted variants. [review]
  • MUST distinguish definition version, requested package version, and upstream commit where relevant. [review]
  • MUST describe outputs and side effects, including files created or changed. [review]
  • MUST include an Errors section with failure conditions and the caller-visible result. [review]
  • MUST include a valid example and relevant invalid-input examples. [review]
  • MUST name limitations such as unsupported providers or unavailable lifecycle commands. [review]
  • MUST link to guides for complete tasks instead of repeating their steps. [review]
  • SHOULD keep CLI options and serialized fields in tables; use source-shaped examples for APIs. [review]

Schema reference outline

# Project configuration

## Contract

Consumer intent is separate from locked commits and hashes.

## Fields

| Field  | Required | Default  | Behavior                   |
| ------ | -------- | -------- | -------------------------- |
| output | No       | .context | Relative installation root |
| packs  | Yes      | None     | Selected pack requests     |

## Examples

Show a valid local request and a valid Git request.

## Errors

Unknown keys, duplicate identities, and escaping output paths are invalid.

## Limitations

An edited config cannot be restored against a mismatching lockfile.

[review]

Component-content tests check standard metadata and heading structure. Typechecks and behavior tests establish code contracts; review checks reference completeness, including Errors, and compares prose against those contracts.

See Guides for end-to-end actions and Troubleshooting for recovery.

Enforcement

Component-content tests check standard metadata and heading structure. Typechecks and behavior tests establish code contracts; review checks reference completeness, including Errors, and compares prose against those contracts.

See Guides for end-to-end actions and Troubleshooting for recovery.