Stop the README reading like a development log - #7
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Cut the rationale that only made sense while building: why a Vercel cron could not refresh the OMR index, the frame-by-frame drop measurements behind the rapier lengthUnit fix, two TODOs written as prose, the story of two bugs found by writing tests, and the mirror-vs-origin packing verification. There were two Tests sections that contradicted each other, one claiming SceneController is uncovered and one describing its jsdom suite. The second is right, so they are now one section, sitting with CI and Layout. The fallow coverage note and the WCAG AA claim each appeared twice. The test count was stale: 513 across 32 files, about six seconds, not 198 in two. Every other number in the file still checks out.
thebuilder
force-pushed
the
feat/readme-cleanup-388fb8
branch
from
August 27, 2026 13:13
7eaec67 to
b8177e1
Compare
thebuilder
marked this pull request as ready for review
August 27, 2026 13:14
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had accumulated the kind of detail that only makes sense to whoever was in the room when the decision got made. This trims it back to documentation. 161 lines out, 124 in.
Rationale cut
lengthUnitfix (0.019, 0.044, 0.069...). The trap and the fix stay; the raw series was debugging residue.mergeObject"next thing to try, not built yet", and switching off rapier's compat build.Duplication
There were two Tests sections, one under
## Testsand one as a**Tests.**bullet inside How it works, and they disagreed: the first saidSceneControlleris uncovered, the second said it runs in jsdom against a renderer stub. The second is right,src/scene/sceneController.test.tsexists. Merged into one section, moved to sit with CI and Layout. The fallow/CRAP coverage note and the WCAG AA claim each appeared twice; now once each.Stale numbers
198 tests, about two secondswas well out of date. Installed deps and ran the suite: 504 tests across 32 files, 5.8s.Everything else I checked held up, so it stayed as written: 194 palette parts in 9 groups, 1,470 OMR sets, 19 KB gzipped index, 280 KB gzipped palette, and all six manifest brick/step counts.
Prose
No em dashes left. Rewrote colons used as mid-sentence connectors, dropped the bold on build mode and Free build in the intro, and renamed "The problem this repo solves" to "Why models are packed".
The voice is otherwise untouched. The opinionated lines and the measured numbers in Performance and Build mode are the parts a reader can't get from the code, so they stay.
For the reviewer
Docs only, no code changes. Worth a skim of the
## Testssection in particular, since it now describes what the suites actually do rather than what they did some commits ago.