Guides

Enable channels, then verify

Enable the AI Channels a Project needs, validate the source docs, preview generated files, then sync.

AI Channel config

Enable outputs in sumr.yaml.

The source folder stays stable. The channel flags decide which generated files are written for the current Project.

sumr.yamlyaml

playbook:
  sources:
    - docs
  channels:
    codex: true
    claude: true
    cursor: true
    copilot: false

One Resource can serve several AI Channels without maintaining parallel vendor-specific copies.

Before sync

Validate, preview, then write.

Validation catches broken frontmatter and unsupported shapes before generated files change. Dry-run sync shows what each AI Channel will receive.

Need the command details? Open validate source docs or sync generated files.

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

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.