Repository navigation
Plain-language pass, phase 2 — RTD documentation - #5
Merged
Merged
Conversation
Plain words first; irreplaceable terms defined at first use. The format page's normative statements (field definitions, hash definitions, AXMR1 rules) are verbatim; only explanatory prose around them was passed. Verified: numeric tokens identical before/after; mkdocs build --strict clean.
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.
Owner directive 2026-10-12 (plain language everywhere, refined standard): plain words first; irreplaceable terms defined in plain words at first use; results stated as what they mean, with the technical value following once. Language only — no behaviour, verdict, or number changed.
All five pages passed (index, api, format, verification, float-canonicalization). The format page's normative statements — field definitions, hash definitions, the AXMR1 rules — are verbatim, per the brief; only explanatory prose around them was rewritten (e.g. the current view's fold is now explained in plain words, and 1 ULP is spelled out as one unit in the last place at first use).
Verification: mkdocs build --strict passes with zero warnings; numeric-token audit before/after is identical on all five pages.