Repository navigation
docs: add missing rules from the docs style guide project - #30782
Merged
nickvigilante merged 5 commits intoOct 16, 2026
Merged
nickvigilante merged 5 commits into
nickvigilante merged 5 commits into
Conversation
Add the style rules from the Docs style guide Linear project that the guide was missing, and fix the guide's own self-violations from the second ASD-STE100 audit. Each new Vale rule lands in its own PR based on this one, so every footer for those rules is marked planned. The Vale doctrine now lets suggestion-level rules land with existing findings, per Nick's decision on DOCS-450. Refs DOCS-1282, DOCS-1265
This was referenced Oct 14, 2026
This was referenced Oct 14, 2026
… limit to the whole step
…tyle-guide-add-missing-rules-from-the-docs-style-guide # Conflicts: # docs/.style/style-guide/README.md
nickvigilante
deleted the
vigilante/docs-1282-style-guide-add-missing-rules-from-the-docs-style-guide
branch
October 16, 2026 13:53
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.
Summary
Adds the style rules from the Docs style guide project (DOCS-1282) that
docs/.style/style-guide/was missing, and fixes the guide's own self-violations and contradictions from the second ASD-STE100 audit (DOCS-1265).Each new Vale rule lands in its own PR based on this branch, so every footer for those rules reads
(planned)here.Changes
do not, notdon't); leave out "please"; how to count words; full clauses instead of-ingclauses in steps; words that have one meaning (ensure,should,may,since); US spelling; noun stacks of three words or fewer; no periods in acronyms; inclusive LGBTQ terms;grandfatheredin the inclusive substitutions, with a link to the history of the grandfather clause.e.g.,i.e., andetc.outside tables, and accept either form.IMPORTANTcallouts carry information, never actions.suggestionrules can land with existing findings. Warning and error rules still ship clean.tears downidiom, gerund headings indocs/.style/README.md, semicolons in the DOC3 dash advice, and the numeric-range contradiction.Testing
go run ./scripts/styleclaims: passes.markdownlint-cli2andmarkdown-table-formatteron every changed file: pass.scripts/check_emdash.sh: passes.valeon the changed files that Vale lints (docs/.style/README.md,content-guidelines.md,docs/AGENTS.md): zero findings.pre-commit-lighthook: passes.Decision log
Source
The second ASD-STE100 audit compared the guide with ASD-STE100 Issue 9, and a catalog of the Linear project listed every rule missing from the guide.
Nick reviewed each item and chose to add it, defer it, or edit only the guide.
Decisions
Coder.Please,Coder.AcronymPeriods(a Coder copy ofGoogle.Periodsthat also catches 2-letter acronyms),Coder.InclusiveLanguage,Coder.LGBTQ,Coder.USSpelling,Coder.AmbiguousWords(suggestion),Coder.ImperativeNegation,Coder.StepLength,Coder.Semicolons,Coder.CheckOut,Coder.LatinAbbreviations(suggestion).IMPORTANTcallouts, feature versus instance capitalization, and noun stacks. A part-of-speech prototype missed every test stack.-ingVale rule (DOCS-1287), and the product-name Vale rules (DOCS-1285 and DOCS-1288).Open for review
formatting.mdcode-font list and the US-style quotation example).Generated by Coder Agents on behalf of @nickvigilante.