Skip to content

Docs: every Octatrack package import re-exports Analog BD's proofs and re-pins the standalone recipes - #1144

Merged
repeat98 merged 1 commit into
mainfrom
docs/module-release-pins
Nov 1, 2026
Merged

repeat98 merged 1 commit into
mainfrom
docs/module-release-pins

Conversation

@repeat98

@repeat98 repeat98 commented Nov 1, 2026

Copy link
Copy Markdown
Owner
  • What was wrong or hard: docs/ADD_A_MODULE.md said Analog BD's composition proofs need a re-export only for a new ColdFire USB module. Every package import does two things the guide didn't mention. It moves module-build.json's source-tree hash, which analog-bd-composition-proofs.json pins, so src/engine/analog-bd.test.ts fails. It also rewrites four asset files (dsp-packages.json, descriptor-recipes.json, menu-recipes.json, rom-packages.json) that Tape Echo's and Euclid's standalone recipes pin, so test_published_module_packages_rebuild_byte_for_byte fails with "The standalone recipe does not name the exact source/image inputs". I hit both on VECTOR 0.2.6 (VECTOR 0.2.6-experimental: SRC SETUP page 2 on VECTOR's own row, wherever it sits (#1119) #1141). Analog BD 0.1.6 (6cc7b4d) had done both steps without the guide saying so.
  • What this changes: step 4 says every import needs both steps, and the clause about new USB modules loses its now-duplicate half. To stay under the 32 KB limit, three nearby sentences are tightened without losing content: "What it builds", "Your firmware", "New shapes", and the CI-classifier sentence in the editorial-update section.
  • How I checked it: npm run pr:ready says Ready; the document is 32,695 bytes. Both steps were done this way on VECTOR 0.2.6-experimental: SRC SETUP page 2 on VECTOR's own row, wherever it sits (#1119) #1141: all 212 Analog BD proofs re-exported byte-identical, and the rebuild test passes after the re-pin.
  • What the guides lacked or got wrong, and where I fixed it: this PR. One more thing left out for size: an owner-approved update's catalogue regenerates only with the owner's approval, so module:verify and the site's composer can't run before it. To try a fix in ot_emu first, build and import (--development) the changed source at the released version. That may belong in docs/MODULE_UI_CAPTURES.md or the emulator guide if you want it written down.

🤖 Generated with Claude Code

…d re-pins the standalone recipes

ADD_A_MODULE named the Analog BD proof re-export only for a new USB module.
Any import moves the module source tree those proofs pin, and rewrites the
four asset files Tape Echo's and Euclid's standalone recipes pin. Room made by
tightening three nearby sentences (32 KB limit).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 1, 2026
@repeat98
repeat98 merged commit c556802 into main Nov 1, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant