Docs-as-Code · automated editorial review
Prose governance system
A Vale ruleset and CI pipeline that enforces editorial standards on prose the way a linter enforces them on code. Every rule names the defect it prevents, and a closing section names the rules that were deliberately not written.
- Each rule carries the defect it prevents, so a writer who trips it learns the standard instead of just satisfying the tool.
- Severity carries weight: errors block the merge, warnings do not, and the page defends where it drew that line.
- The pipeline reports on the pull request with file and line, because a CI failure a writer cannot locate is a CI failure they will route around.
- A section on the rules deliberately left out. A linter that flags too much teaches writers to game it.
Vale · GitHub Actions · Google developer documentation style
The ruleset, and the defect each rule prevents
ExplanationEvery rule justified by the failure it stops, plus the rules that were considered and rejected.
vale.ini and the custom styles
ConfigurationThe enforceable half: configuration and rule definitions.
docs-quality.yml
ConfigurationThe GitHub Actions workflow that runs the ruleset and annotates the pull request.