Repository navigation
Rewrite the site in plain sentences - #48
Merged
Merged
Conversation
The home page, the guide, the articles, the vision, the principles, and the recipes. The claims, the numbers, the samples, and the decision records stay as they were.
The previous pass split clauses until paragraphs read as a stack of "it" sentences. Related clauses are joined again. Facts and samples are unchanged.
shergin
changed the title
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.
Summary
The documentation site was hard to read. Sentences stacked several mechanisms at once, and a new word often arrived without a plain definition.
This rewrites the pages a reader actually walks: the home page, getting started, the GraphQL tour, the walkthrough, the guide, the gallery blurbs, the articles, the vision, the principles, and the recipes. The prose is plain and readable. A word is defined once, in ordinary language. The claims, the benchmark numbers, the code samples, and the figure directives are unchanged.
Decision records, the terminology contract, the runtime contract, and the specification stay as records.
Test plan
cargo run --manifest-path site/Cargo.tomlwrote 115 pages and 105 plates