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 generate_doc.sh, 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.
Finding and inspecting documents
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/.
Maintenance
- How do I deduplicate two documents? — nominate survivor, merge unique content, delete duplicate, relink all UUID references.
Validation
- How do I validate component documentation before committing? — run
validate_docs.shbefore pushing any component doc change.
See also
- Document types — the doc contract every doc satisfies.
- Recipes index — sibling topics.