docs: Vale prose linting (Microsoft style) + CI gate#10
Open
Ti-03 wants to merge 1 commit into
Open
Conversation
Add .vale.ini using the Microsoft Writing Style Guide and a prose-lint job in the existing CI workflow so docs style violations fail the build. Fix all flagged issues across the guide, ADR, and README (contractions, quote punctuation, spaced em dashes, adverbs). Styles are synced by CI, not committed.
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.
Adds the Vale prose linter to the docs, using the Microsoft Writing Style Guide, and wires it into the existing CI workflow so style violations fail the build.
What's here
.vale.ini: Microsoft style,MinAlertLevel = error(clear-cut violations block; advisory warnings still print),Vale.Spellingoff so API symbols in the reference pages aren't flagged.prose-lintjob in.github/workflows/ci.yml: runs on ubuntu-latest, pinned Vale 3.15.1,vale syncthenvale guide docs/adr README.md.vale sync(gitignored), so CI is reproducible from a clean checkout.Verification
rm -rf .github/styles && vale sync && vale guide docs/adr README.mdfrom a clean state: 0 errors, 0 warnings in 7 files.Follow-up to #9 (docs site + first ADR), which merged before this was ready.