Make this repository the engines' home; the course copies from here

Whether the engines' changes went back to the course or the course took
them from here was an open question (docs/engines.md). Soundness fixes to
the prover cannot wait for a round trip through a repository with no engine
tests, so this repository now owns the engines.

- pixi run engines-export <course>/static builds and writes every engine
  module into the course's static/js/: JavaScript modules as written,
  TypeScript ones (logic, solver, vcgen) as built, without source maps.
- pixi run engines-diff now shows what the course has not taken yet,
  comparing the file the course would receive with its copy. Both scripts
  share the list of modules in scripts/engines-files.mjs.
- docs/engines.md describes the ownership, the prover's three modules and
  its number model, the soundness tests and the bugs found so far, the
  changes the course receives with the next export, and how to export.
- AGENTS.md gains a hard rule: never let the prover call something proved
  that a run breaks, with how to add a soundness regression first.
- docs/app.md's Known limits no longer sends engine fixes upstream.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FgvbRdoEheAHqsRmr2WuKZ
This commit is contained in:
alexmandClaude committed 2026-10-05 03:33:58 +00:00
1 parent 2416d7fc8e
commit 0d313f989d
8 files changed
+151 -42

No files matched your search

+4 -3
View File
@@ -40,7 +40,8 @@ Every command is a pixi task (`pixi task list` shows them with their description
| `dev` | Build, then serve on http://localhost:4173 |
| `test` | Build, then run every test, the corpus pipeline's Python tests included |
| `check-pages <dir>` | Run every program embedded in the Quarto pages under a folder ([quarto/README.md](quarto/README.md)) |
| `engines-diff <static>` | Compare the vendored course code with a course checkout ([docs/engines.md](docs/engines.md)) |
| `engines-diff <static>` | Show what a course checkout has not taken yet from the engines and stylesheets ([docs/engines.md](docs/engines.md)) |
| `engines-export <static>` | Copy the engines into a course checkout, TypeScript modules as built ([docs/engines.md](docs/engines.md)) |
| **Write content** | |
| `new-exercise <id>` | Start an exercise whose Mojo lives in `mojo/local/<id>.mojo` ([docs/exercises.md](docs/exercises.md)) |
| `new-probe <name> <question>` | Start `mojo/probes/<name>.mojo`: one question about the compiler ([docs/mojo-corpus.md](docs/mojo-corpus.md)) |
@@ -90,7 +91,7 @@ src/
ui/hw/ the Hardware area's machine board, over the course's x86-64 views
exercises/ one file per catalog problem
curriculum/ a lesson corpus kept as an interpreter fixture (tests/curriculum.test.mjs); no UI
engines/ the course site's language engines (docs/engines.md); do not edit here
engines/ the language engines this repository owns and the course copies (docs/engines.md)
vendor/ CodeMirror 6 as one built module; scripts/vendor/ rebuilds it
styles/course/ the course site's widget stylesheets, copied unchanged (and bridge.css, ours)
tests/ node --test against dist/; tests/corpus/ holds pseudo regression programs
@@ -112,6 +113,6 @@ scratch/ ignored by git: a place for experiments
| [docs/exercises.md](docs/exercises.md) | Adding a catalog problem |
| [docs/mojo-corpus.md](docs/mojo-corpus.md) | Writing Mojo of our own (probes, exercise programs, stress programs) and moving to a new Mojo version |
| [docs/asm-coverage.md](docs/asm-coverage.md) | Which instructions compiled Mojo uses, against what the machine models |
| [docs/engines.md](docs/engines.md) | The vendored course engines and stylesheets, and how they differ from the course |
| [docs/engines.md](docs/engines.md) | The language engines this repository owns, their tests, and how the course takes them |
| [docs/deploy.md](docs/deploy.md) | Building the site and publishing it to the droplet |
| [quarto/README.md](quarto/README.md) | Embedding views in a Quarto site |