Doc Add Recipe

Table of Contents

When to use this skill

When you need to author a new recipe — a single how_do_i_*.org file that answers one NLP question with executable steps. For bulk-sync work (compare source-of-truth against a whole recipe topic), use ORES Recipe Sync instead.

How to use this skill

The full procedure lives in the recipe How do I create a recipe? — this skill exists to surface it under a name an LLM session can invoke.

  1. Pick the topic folder under doc/recipes/<topic>/. Existing topics: cli, http, shell, sql, cmake, codegen, documentation, emacs, git, github. To list every recipe in a topic:

    ./projects/ores.compass/compass.sh list --tag <topic> --type recipe
    

    If the topic does not exist yet, create the folder and a <topic>.org inventory page first.

  2. Phrase the question. Filename, #+title:, and * Question body must agree: how_do_i_X_Y_Z.orgHow do I X Y Z?.
  3. Scaffold with the codegen and fill in * Question, * Answer (numbered steps with executable #+begin_src sh :results verbatim blocks), * Script, * Tested by. Full conventions in How do I create a recipe?.
  4. Wire into the topic inventory at doc/recipes/<topic>/<topic>.org.
  5. Verify via compass.sh show <uuid-prefix> — incoming and outgoing links should all resolve.

Recipes

Reference

  • Recipe (glossary) — the contract.
  • Recipes — the cross-topic inventory.
  • Document types§=recipe= — required sections, conventions.
  • ORES Recipe Sync — sibling skill for syncing a whole topic against its source-of-truth.

Emacs 29.1 (Org mode 9.6.6)