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

Tutorials

A tutorial teaches by building a small working example. Explain the decisions the reader is practicing, while keeping deeper contracts in reference pages.

Learning contract

Why

Creating a bundle teaches entrypoints, file selection, and content versions better than listing their names. Each step needs a visible result so the reader can tell when to proceed.

Rules

  • MUST include What you will learn, What you will build, and Prerequisites. [review]
  • MUST keep the build to at most seven numbered steps. [review]
  • MUST state the visible outcome of each step. [review]
  • MUST explain the concept introduced by that step without turning it into a full reference. [review]
  • MUST keep sample identities and material local to the tutorial rather than presenting them as catalog entries. [review]
  • MUST finish with Verification, Summary, and Next steps. [review]
  • MUST include Troubleshooting for failures likely to interrupt the build. [review]
  • SHOULD link a quick start for readers who only need the first working result. [review]

Example outline

# Build a local reference pack

## What you will learn

How an entrypoint, positive file selection, and pack version describe existing material.

## What you will build

A small local bundle that another directory can install.

## Prerequisites

A Granary source checkout, Node.js 26+, the pinned pnpm version, and a POSIX shell.

## 1. Create the material

Write a short entrypoint and one guide; verify both files exist.

## 2. Describe the bundle

Write a manifest whose files include the entrypoint.

## 3. Validate and install

Validate the metadata, then install it into a fresh consumer.

## Verification

Inspect the installed files, generated index, config, and lock.

## Summary

The manifest selected existing files; the consumer recorded intent and concrete integrity.

## Troubleshooting

If the entrypoint is excluded, correct selection before retrying.

## Next steps

Extend the example into a curated definition when it needs separate upstream groups.

The outline describes sections, not a runnable shell transcript. A published tutorial must supply the complete files and commands for each step.

[review]

Component-content tests check standard metadata and heading structure. Review checks the tutorial's named task sections, step limit, learning sequence, and execution from its stated starting point.

See Quick starts and References.

Enforcement

Component-content tests check standard metadata and heading structure. Review checks the tutorial's named task sections, step limit, learning sequence, and execution from its stated starting point.

See Quick starts and References.