Task: Implement runbook support
This page documents a task in the Runbook support story. It captures the goal, current status, acceptance, and any notes or results.
Goal
Add runbook as a recognised v2 document type with full tooling support and a concrete example.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Runbook support |
| Now | Complete. |
| Waiting on | Nothing. |
| Next | None. |
| Last touched | 2026-05-28 |
Acceptance
- ores.codegen accepts
--type runbookand produces a valid skeleton with Goal, Preconditions, Steps, Postconditions, See also. - Compass supports
compass add runbook(delegates to codegen). - Document types defines the runbook frontmatter contract and required sections.
- Glossary defines
runbookwith a stable id-link pointing to the concrete example. - A concrete runbook at
doc/runbooks/start_new_story/runbook.orgchains: compass add story → fill content → branch → mark STARTED → wire sprint → commit → push → PR.
Plan
(Transient implementation strategy. Written when work starts;
distilled into the parent story's * Decisions and cleared when the
task closes. Plans do not outlive their task.)
Notes
- Template at
projects/ores.codegen/library/templates/v2_doc_runbook.org.mustache. - Codegen updated:
TYPE_TO_TEMPLATE,DEFAULT_INITIAL_STATE,PARENTLESS_TYPES. - Compass requires no changes (delegates to codegen via
v2_doc_generate.main()). - Glossary UUID:
B555D2A6-10CA-4A93-973E-F2AF4E1D7E55. - Concrete runbook UUID:
4F01E2FF-69AB-4839-88D1-4D8C21D99D3C.
PRs
| PR | Title |
|---|---|
| 861 | [runbook] Add runbook document type with codegen, glossary, and concrete example |
Review
| # | Comment summary | File | Decision | Notes |
|---|---|---|---|---|
| 1 | Script name: use full path to generate script | document_types | Applied | Added projects/ores.codegen/ prefix |
| 2 | Clarify recipe-or-skill in template blurb | template | Applied | "recipe" → "recipe or skill" |
| 3 | Clarify recipe-or-skill in runbook blurb | runbook | Applied | "recipe" → "recipe or skill" (both runbooks) |
Result
Added runbook as a v2 document type: codegen template, --type runbook support, glossary entry (B555D2A6), document types contract, and concrete runbook start_new_story/runbook.org (4F01E2FF). Merged in PR #861.