Stop the README arguing its own case - #11
Merged
Merged
Conversation
Every decision in here came with the reasoning that produced it: why bags exist before what they are, why a hand-written palette would go stale before what the rules yield, a paragraph on instruction booklets before the subassembly rule. Read once it is interesting. Read while you are trying to find the threshold you came for, it is in the way. The facts stay, numbers included. What goes is the argument around them: 4,457 words to 3,234. Also fixes the test counts, which had drifted to 513 across 32 files, and drops the Running Bond Wall row, which left with #9.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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 explained every decision by first making the case for it. Why bags exist before what a bag is, why a hand-written palette list would go stale before the number of parts the rules actually yield, a paragraph about instruction booklets before the subassembly rule. It reads well once. It is in the way when you are scanning for the threshold you came for.
The facts stay, numbers included. What goes is the argument around them.
4,457 words to 3,234, 496 lines to 393. Nothing was cut that a contributor needs:
lengthUnitagainst 0.4mm LDraw units, the odd/even footprint half-stud error, the0 FILEnaming table, the half turn about X being its own inverse.Also fixed while in here
#8a5a00landed at the start of a line, which Markdown renders as an<h1>. Reflowed so no line starts with a hex.Verification
Numbers re-checked against the repo rather than carried over:
pnpm testreports 558/34,public/models/manifest.jsonlists the five models in the table with matching brick and step counts, andpublic/parts/palette.jsonhas 194 parts across nine groups. Heading structure and both relative workflow links are intact.Docs only, no code touched.