Recipes
Recipes are short, tested, executable how-to documents. Each one
answers exactly one question (how do I X?). Topics group related
recipes; each topic has its own inventory that lists its recipes.
Topics
- Agile recipes — open sprints, generate release notes.
- CMake recipes — build, test, deploy.
- Codegen recipes — run the C++ generator, scaffold docs.
- Documentation recipes — find docs, inspect links, author new recipes.
- Compass recipes — the compass tool: orient, search, index, navigate.
- Emacs recipes — org-babel and other emacs-specific workflows.
- CLI recipes — using the CLI tool with entity-based syntax.
- Shell recipes — using the client REPL.
- HTTP recipes — exercising the HTTP API.
- SQL recipes — direct SQL queries against the ORE Studio database.
- Ops recipes — environment management, log files, service health, infrastructure troubleshooting.
- Git recipes — pure git workflows (branches, submodules).
- GitHub recipes —
ghCLI, PRs, CI checks, review threads. - LLM prompt recipes — reusable prompts for LLM chat interfaces.
- PlantUML recipes — add and maintain diagrams in org-mode documents.
See also
- The component documentation guide — how to write a
component_overview.orgthat passes audit. - New service checklist — multi-step procedure for introducing a new domain service. Treated as one document rather than a set of recipes because the steps are sequential and inter-dependent.