Document type: recipe

Table of Contents

This page defines the recipe document type — one entry in the document types taxonomy. The general contract every document follows (frontmatter, state, linking, tags) lives on the taxonomy page; this page carries only what is specific to recipe.

Contract

Folder
recipes/<topic>/
Level
cross
Filename
starts with how_do_i_ or similar NLP question phrasing.
(no term)
Not stateful by TODO, but audit may set a :stale: tag when the script fails.
How to create
see New recipe in the codegen recipe.
Required sections
  • * Question — the NLP question.
  • * Answer — the steps. Shell commands inside an * Answer belong in #+begin_src sh :results verbatim blocks so they can be executed in place (C-c C-c in emacs); when the captured output is the value of the recipe (e.g. list available presets), keep #+RESULTS: alongside as a snapshot.
  • * Script — pointer to the script or wrapper that does the work, where applicable.
  • * Tested by — link to the CI check that exercises the recipe.

Emacs 29.1 (Org mode 9.6.6)