docs(docs/.style/style-guide): add directional-language and contractions rules - #26729
Merged
nickvigilante merged 3 commits intoJul 8, 2026
Conversation
…p existing pages
Add a new accessibility-and-inclusion rule that warns against spatial references like "see below", "above", or "the menu on the left", which screen-reader users navigating linearly cannot interpret. The rule prescribes anchor links, section headings, document order ("the previous section", "the following section"), and named UI elements instead. A replacement table covers the common cases.
Sweep the six style-guide subpages so the existing rule examples and prose comply. Captions "go below" become captions that "follow". "At the top of the page" becomes "at the beginning of the page". "As described below" inside the Latin abbreviations table dropped; the next paragraph supplies the detail. "10th and up" becomes "10th and higher". "As shown above" inside the screenshot-as-content Don't example becomes "as shown in the screenshot".
Idiomatic stack metaphors ("built on top of Terraform") and phrasal verbs ("set up", "back up", "log in", "shut down") are explicitly carved out and stay as-is.
Lints clean: make lint/markdown and make lint/prose.
nickvigilante
force-pushed
the
vigilante/docs-462-add-screen-reader-aware-directional-language-rule-and-sweep
branch
from
June 25, 2026 21:34
6302d57 to
90d903d
Compare
Add a new voice-and-tone rule that prefers contractions in body prose for the same reason the docs use second person and present tense: the prose should read like a person talking to the reader.
Three exceptions. (1) Auxiliary contractions like 'you'd', 'there's', 'it's', 'we'd', and 'they're' cannot end a sentence because the elided verb form goes missing with them. Negation contractions like 'don't', 'won't', and 'can't' end sentences fine. (2) Contractions join exactly two words. Triple-word contractions like 'you'd've' and 'wouldn't've' get expanded to one of two forms ('you would've' or 'you'd have') depending on which reads more naturally. (3) Data loss, security warnings, and irreversible operations get the full visual weight of 'do not', 'cannot', and 'will not'.
Section lands between 'Present tense by default' and 'Trailing prepositions are a judgment call' because all three rules sit in the natural-phrasing cluster of voice-and-tone.
Lints clean: make lint/markdown and make lint/prose.
…rtunities
Apply the contractions rule across the existing style-guide subpages. 76 lines updated where the spelled-out form ('does not', 'is not', 'cannot', 'you have', 'there is', 'that is') reads more naturally as a contraction.
Skipped: Don't blocks inside the contractions rule that intentionally demonstrate the wrong form; Do blocks inside the emphasis sub-rule that intentionally model 'do not', 'cannot', and 'will not' for high-stakes operations; the Churchill joke inside the trailing-prepositions Don't blocks; and the 'that is' dictionary definition of i.e. in the Latin abbreviations table.
Skipped 'may not' (no contraction in modern English), 'must not' (zero matches), and 'that has' relative clauses where ''s' could read as possessive.
Lints clean: make lint/markdown and make lint/prose.
bpmct
approved these changes
Jul 8, 2026
nickvigilante
deleted the
vigilante/docs-462-add-screen-reader-aware-directional-language-rule-and-sweep
branch
July 8, 2026 16:05
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds two new accessibility-and-voice rules to the style guide.
Directional language (
docs/.style/style-guide/accessibility-and-inclusion.md). Screen-reader users navigate documents linearly and cannot follow spatial references like "see below" or "the menu on the left". The rule prescribes anchor links, section headings, document order ("the previous section", "the following section"), and named UI elements instead. A replacement table covers the common cases.Contractions are the default (
docs/.style/style-guide/voice-and-tone.md). Prefer contractions in body prose for the same reason the docs use second person and present tense. Three exceptions: auxiliary contractions (you'd,there's,it's,we'd,they're) need an explicit complement and cannot end a sentence; contractions join exactly two words (noyou'd'veorwouldn't've); spell out for emphasis and high-stakes operations like deletion or data loss (do not,cannot,will not).The PR also sweeps the existing style-guide subpages so the existing prose comply with both rules.
Resolves DOCS-462.
Directional-language sweep targets
docs/.style/style-guide/README.mddocs/.style/style-guide/accessibility-and-inclusion.mddocs/.style/style-guide/audience-and-scope.mddocs/.style/style-guide/capitalization-and-punctuation.mddocs/.style/style-guide/formatting.mddocs/.style/style-guide/numbers-units-and-dates.mdIdiomatic stack metaphors like "built on top of Terraform" and phrasal verbs like "set up", "back up", "log in", and "shut down" are explicitly carved out as not directional and stay as-is.
Contractions rule scope
The rule lands as
## Contractions are the defaultinvoice-and-tone.md, placed betweenPresent tense by defaultandTrailing prepositions are a judgment callbecause all three rules sit in the natural-phrasing cluster.The sweep applies the rule across all eight style-guide subpages: 76 lines updated where the spelled-out form (
does not,is not,cannot,you have,there is,that is) reads more naturally as a contraction.Skipped:
do not,cannot, andwill notfor high-stakes operations.i.e.in the Latin abbreviations table.may not(no contraction in modern English).that hasrelative clauses where'scould read as possessive.Lints
make lint/markdown: 0 errors across 495 files.make lint/prose: only the pre-existing intentional[Demo]annotations indocs/.style/_vale-annotation-demo.mdfire.Filed via Coder Agents on Nick's behalf.