Documentation recipes
Table of Contents
Recipes for working with the documentation as a graph — finding
docs, following links, and writing new ones that satisfy the
contract. Authoring recipes physically live under
recipes/codegen/ because they drive compass add, but
appear here too since they're how you create doc-graph entries.
For the codegen scripts that generate code (not docs) see the
Codegen recipes topic.
1. Finding and inspecting documents
2. Authoring documents
- How do I create a recipe? — recipe-specific conventions; this recipe lives here.
- How do I create a memory? — project-scope memory authoring.
- How do I create a new doc? — generic scaffold flow;
physically under
recipes/codegen/. - How do I create a component overview? — component scaffold
flow; physically under
recipes/codegen/. - How do I document an entity? — the thesis chapter structure, prose tone, domain-knowledge sourcing, screenshot placeholders, and manual wiring for an entity's user-guide chapter.
- How do I capture screenshots for a manual chapter? — turns a chapter's placeholders into real, cropped, correctly-named images via the QA Validation Runner.
- How do I clean code comments? — the cleanup pass of the compass-code-review-comments skill: scope, rules, preserve, report.
3. Maintenance
- How do I deduplicate two documents? — nominate survivor, merge unique content, delete duplicate, relink all UUID references.
4. Validation
- How do I validate component documentation before committing? — run
validate_docs.shbefore pushing any component doc change.
5. See also
- Document types — the doc contract every doc satisfies.
- Recipes index — sibling topics.