Repository navigation
docs: rewrite READMEs for zero-background readers - #6
Merged
Merged
Conversation
Apply the blank-reader-30s-test: lead with who it's for and what it does, expand fsync/QD1/DIRECT/p95/OpenVZ on first use, add a dedicated comparability section, surface the jsDelivr note with context, add a glossary table.
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.
Pass the blank-reader 30-second test on both READMEs.
Before: first sentence required knowing what fsync is, never explained
who should run this or why, dropped 'DIRECT=1' and 'OpenVZ' mid-doc with
no setup, mixed 'compare two VPSes' criteria inside a scoring section,
and left the China-network jsDelivr fix without context.
After: opens with 'run this before you rent a VPS', expands every jargon
term at first use, adds a glossary table, splits comparability into its
own section, gives the jsDelivr mirror a reason to exist.