How to

Validate docs

Catch frontmatter and structure issues before sync.

What changes

validate loads configured docs sources, checks required frontmatter and Playbook structure, and reports errors before sync writes AI Channel output.

When this helps

You created or edited a Playbook Markdown file.
A generated AI Channel file looks wrong and the source needs checking.
CI or a reviewer needs a no-write quality gate.

Run this command

terminal

$sumr playbook validate --source docs# check source docs$sumr playbook validate --verbose# show checked files$sumr playbook validate --json# CI output

Flags you can use

--source <path>

Validate one docs folder instead of reading sources from sumr.yaml.

--verbose

On success, list every source that was checked.

--json

Return a structured JSON envelope for scripts, CI jobs, and AI assistants.

--help, -h

Show the command syntax, supported flags, and examples without changing files.

Keep in mind

Run this before sync when source docs changed.
Fix validation errors in the source Markdown, not in generated channel files.