Repository navigation
Foundation: recipe template and scaffolder #68
Description
Goal
A worked template that satisfies the recipe contract, and a command that stamps out a new recipe folder from the catalog.
Scope
recipes/_template/withnotebook.ipynb,README.md,fixtures/, and the optionalhelpers.pyandtests/, implementing a tiny but complete example against the contract inCONTRIBUTING.md.- The notebook section order every recipe follows: what you will build, setup and run mode, the state, the questions, one answer up close, Python's part, evaluation, what was and was not measured, next steps.
python tools/new_recipe.py NNcreatesrecipes/NN-slug/fromcatalog/recipes.jsonwith title, level, decision types, use case, and sources filled in.- The import convention for
helpers.pyfrom a notebook and from tests, written down. tools/render_catalog.pyignores_template.
Acceptance criteria
- The template notebook runs top to bottom offline and its fixtures validate
- The scaffolder is tested and refuses to overwrite an existing recipe
- A new contributor can go from scaffold to a running notebook using only the template README
- Lint and tests pass in CI, or locally with the output pasted in the pull request if CI does not exist yet
Dependencies
- Blocked by Foundation: decision backends with typed answers, replay, and scripted modes #63 (decision backends with typed answers, replay, and scripted modes)
- Blocked by Foundation: fixture specification and validator #65 (fixture specification and validator)
- Blocked by Foundation: evaluation toolkit #66 (evaluation toolkit)
- Blocked by Foundation: notebook style, plotting theme, and run-mode header #67 (notebook style, plotting theme, and run-mode header)
- Unblocks Foundation: CI executes every notebook offline and validates fixtures #69, Foundation: reader documentation for getting started, offline and live modes, and the glossary #72
- Tracked in Epic: Foundation #74
References
- Recipe contract
- Catalog
- TypeSafe documentation index for tools: https://docs.typesafe.ai/llms.txt
- Python SDK: https://docs.typesafe.ai/sdk/python
Activity
Foundation: project scaffolding and Python package skeleton (#81)
CompleteDotTech commentedon Oct 6, 2026
Teaching-contract handoff from independent PR91 Opus review #91 (comment): ensure the recipe README template explicitly discloses actual run mode and, for recorded inference, returned model/version, capture date and measured N. The updated root note expects notebook and README disclosure. Preserve fixture provenance and the owner recording requirement; do not invent recordings. If mixed synthetic/recorded recipe evidence is supported, disclose modes per fixture rather than one ambiguous header. These are template acceptance details, not a new implementation owner.
Foundation: reconcile recipe catalog integration and orchestration ru…
CompleteDotTech commentedon Oct 7, 2026
Template review handoff from genuine PR91 Opus6028667795: require N explicitly for every reported recorded Jev metric in notebook headers AND reader README, alongside returned model identity and capture date. Current run_header makes n optional, so its default is not sufficient proof of the #80 recording/claims requirement. Template defaults may demonstrate synthetic pipeline behavior, but recipe delivery must preserve individually required authentic recording coverage and label synthetic/scripted runs honestly. Keep prior fixture-mode and keyless/network-blocked execution requirements. Resolve through existing68 Sonnet ownership and both independent Opus finalhead reviews; this is requirements evidence, not a new writer.