opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(docs/.style/style-guide): sync tooling rule counts with coverage table

Browse Source 
The narrative still read 77 rules and 8 tool-checked. Coder.UnitSpacing
makes 9 tool-checked, and the total has been 79 since #29758 added 2
documentation-only rules without updating this paragraph.

Refs DOCS-1072
This commit is contained in:
Nick Vigilante
2026-09-25 22:32:02 +00:00
parent f7c8563734
commit b3c53b6874
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/.style/style-guide/README.md
+3 -3
View File
@@ -22,9 +22,9 @@ The doctrine for adding Vale rules lives in the [Vale doctrine README](../README
## What the tooling checks, and what it doesn't
A clean `make lint/prose` run is not evidence that a page follows this guide.
The guide documents 77 rules.
Automated tooling checks 8 of them, and 1 of those 8 doesn't run on published pages.
The other 69 are yours to apply by reading, 70 on published pages, where the one-sentence-per-line rule is off.
The guide documents 79 rules.
Automated tooling checks 9 of them, and 1 of those 9 doesn't run on published pages.
The other 70 are yours to apply by reading, 71 on published pages, where the one-sentence-per-line rule is off.
Open the section that matches what you're writing and work through it.
The linters catch a narrow band of mechanical errors; they can't tell you that a page serves 2 audiences, buries a required step in a `NOTE`, or wraps every paragraph at 80 columns.