Guides

Write Playbook Docs

Start with the decision you are making, then open the focused guide for source docs, Resource types, portable intent, agent instructions, or AI Channel sync.

Guide map

Choose the decision you are making.

Source model

Place guidance in the Project, group reusable knowledge in Catalogs, and keep Resources reviewable before they become AI Channel output.

Resource types

Choose Document, Topic, Reference, team-member, command, workflow, or lifecycle by what Playbook should render next.

Portable intent

Declare model tier, effort, access, and tools once so each AI Channel can map the Resource into its native format.

Agent instructions

Extract durable rules with agents-md markers instead of hand-editing generated Codex, Claude, or Cursor files.

Channels and sync

Enable AI Channels in sumr.yaml, validate source docs, preview generated files, then write outputs.

Safe loop

Validate before generated files change.

If you already know the source model and only need the commands, use this loop and open the sync guide when you need more detail.

terminal

$sumr playbook validate --source docs# check source docs$sumr playbook sync --source docs --dry-run# preview generated AI Channel files$sumr playbook sync --source docs# write generated files