docs: use plainer prose in README and guides - #31
Merged
Conversation
Remove the constructions that read as machine-written: the cleft "X is what Y" sentences, the "X, not Y" closers, the concessive "that is less code and it works", the "counter-shaped happy path" aside, the "local-first story" metaphor, and the "Choose celld to / Choose Solid Objects to" imperative pair. Every technical claim, guarantee, benchmark number, and code sample is unchanged. Prose only.
Greptile SummaryThis PR rewrites README, changelog, API, authorization, benchmark, correctness, and parity documentation in plainer language without changing documented behavior.
Confidence Score: 5/5The documentation-only changes appear safe to merge. The revised prose preserves the documented runtime contracts, security boundaries, compatibility requirements, benchmark data, Markdown structure, and references, with no actionable defect identified. Important Files Changed
Reviews (1): Last reviewed commit: "docs: use plainer prose in README and gu..." | Re-trigger Greptile |
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
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.
Prose-only pass over the README and
docs/. No source, type, test, orfixture file is touched.
Also removed the last em dash in
CHANGELOG.mdand reworded the parityledger's "the wire contract is what both sides guarantee".
Validation
node scripts/check-documentation.mjs— exit 0node scripts/check-parameter-style.mjs— exit 0prettier --check README.md CHANGELOG.md docs/*.md— cleanKept intact: the delivery-boundaries list, the parity statuses, every
benchmark figure, and the Shuffle Up and Play evidence table.