docs: tighten readme positioning and punctuation#40
Merged
Conversation
rodindev
force-pushed
the
docs/truth-pass
branch
from
June 30, 2026 10:17
5e50e8a to
6d6e067
Compare
rodindev
force-pushed
the
docs/prose-pass
branch
from
June 30, 2026 10:17
1de00dc to
27b697d
Compare
rodindev
force-pushed
the
docs/truth-pass
branch
from
June 30, 2026 10:18
6d6e067 to
db6f7ae
Compare
rodindev
force-pushed
the
docs/prose-pass
branch
from
June 30, 2026 10:22
27b697d to
841d309
Compare
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.
What
Merge the README's two overlapping "Why" sections into one and replace every em-dash across the docs with plain punctuation.
Why
The README pitched the same comparison twice with different wording. The em-dash sweep (76 across 15 files) is a house-style pass: commas, colons, and sentence splits read better and keep the prose consistent with how the rest of the project is written. CHANGELOG history is left untouched.
How to test
npm run docs:buildandformat:checkpass