docs: trim README for readability#138
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <[email protected]>
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 this change does
A readability pass over the README, cutting redundancy (net -24 lines):
## Design & docssection, which duplicated## Documentation(both just pointed at the docs site).## Statusfrom a dense, semicolon-heavy run-on into three sentences that keep the real signal: whatstatecovers, thattelemetry/sink/sourceare released,brokeris planned, and that every API is experimental until v1.Why
Less is more for the front door. The Modules table already carries per-module status, and the intro already states the thin-seams philosophy, so the cut sections were repeating signal the reader already has.
Checklist
git commit -s) per the DCOtype: subject)