Repository navigation
feat: enable Coder.Semicolons Vale rule - #30787
Merged
nickvigilante merged 4 commits intoOct 27, 2026
Merged
nickvigilante merged 4 commits into
nickvigilante merged 4 commits into
Conversation
Contributor
nickvigilante
force-pushed
the
vigilante/docs-1261-style-guide-ban-semicolons-in-prose-and-add-codersemicolons
branch
from
October 14, 2026 20:52
63e69a8 to
5af7f91
Compare
Base automatically changed from
vigilante/docs-1282-style-guide-add-missing-rules-from-the-docs-style-guide
to
main
October 16, 2026 13:53
nickvigilante
marked this pull request as ready for review
October 23, 2026 05:14
ianjevans
reviewed
Oct 23, 2026
ianjevans
left a comment
Collaborator
There was a problem hiding this comment.
Left a lot of suggested changes to fix inconsistent one sentence per line usage in the changed files.
ianjevans
reviewed
Oct 23, 2026
ianjevans
left a comment
Collaborator
There was a problem hiding this comment.
Left a lot of suggested changes to fix inconsistent one sentence per line usage in the changed files.
nickvigilante
force-pushed
the
vigilante/docs-1261-style-guide-ban-semicolons-in-prose-and-add-codersemicolons
branch
from
October 24, 2026 05:34
fa9b6b2 to
cdc0051
Compare
Apply the review suggestions that split the sentences a removed semicolon joined, and split the same sentence breaks on pages that main reformatted to one sentence per line after the sweep was written. Reformat the hand-written part of the Prometheus page to one sentence per line. Finish the sweep on pages where the rebase kept main's text, and update the links to the two content-guidelines headings the sweep renames.
nickvigilante
force-pushed
the
vigilante/docs-1261-style-guide-ban-semicolons-in-prose-and-add-codersemicolons
branch
from
October 27, 2026 00:42
cdc0051 to
3e855ff
Compare
nickvigilante
enabled auto-merge (squash)
October 27, 2026 00:42
Main's StepLength sweep split several steps that this branch had also rewritten to drop semicolons. Keep both: main's step split, then the semicolon-free sentences. Split the one new semicolon main added in the Nix integration page, and recount the style guide coverage now that both StepLength and Semicolons are tool-checked. Assisted-by: AI
nickvigilante
deleted the
vigilante/docs-1261-style-guide-ban-semicolons-in-prose-and-add-codersemicolons
branch
October 27, 2026 16:44
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.
Depends on #30782.
Adds
Coder.Semicolons, a Vale rule that flags a semicolon in prose.It enforces No semicolons in prose.
warning.docs/**exceptdocs/.style/style-guide/**.Table cells, code spans, and code blocks keep their semicolons.
The cleanup commit fixes 112 of them across 61 files by splitting sentences, or by using a comma or a connecting word where a split reads badly.
.vale.ini:docs/reference/{api,cli}/*.mdanddocs/admin/setup/configuration-reference.md.Their text is generated from Go source (CLI flag help, Swagger comments), and 25 findings live there.
Fixing them means editing Go and regenerating, so I used a commented exclusion like
Coder.UnitSpacingdoes.Say so if you prefer the Go fix.
vale --output=line docs/reports 0Coder.Semicolonsfindings outside the style guide.I updated the links in
docs/.style/and in.claude/(DOCS_STYLE_GUIDE.md, thewrite-docsanddoc-checkskills).Linear: DOCS-1261
Decision log
paragraph,list,heading,blockquote. Withoutblockquote, a semicolon in a>quote goes unreported, which I checked.Table cells are outside those scopes, so they stay exempt without extra config.
(?<!TL);(?!DR).TL;DRintelemetry.mdis an abbreviation, not punctuation. entities andstyle="a: b;"attributes don't match. Vale can report a real semicolon on the wrong line of a paragraph that contains an entity or raw HTML (for example,modules.md:69pointed at a semicolon on line 71), so cleanup used a paragraph-wide search instead of trusting reported lines.ai-gateway/monitoring.md:105, a YAML comment) isn't reported and stays.; xbecomes. X, then I reviewed the diff and hand-fixed list fragments, parentheticals, and headings.Each new sentence sits on its own line, outside table cells. The hand-written part of
prometheus.mdis also reformatted to one sentence per line.Verify against the code and document exact values,Evidence justifies a claim and does not belong in the claim,STUN returned different addresses and you may be behind a hard NAT.prometheus.mdis in the generated-page exclusion forCoder.UnitSpacingbut not here. Its semicolon was in hand-written prose, so I fixed it..vale.ini), the coverage counts (Capitalization and punctuation 3/7 to 4/6, total 21 to 22 tool-checked and 24 to 23 planned, on top of main'sCoder.StepLength), and the "What the tooling checks" counts.Tests (fixtures in
/tmp, not committed), each run with LF and CRLF files: and&, an HTMLstyleattribute, andTL;DR.go run ./scripts/styleclaims,make lint/emdash, and the pre-commit hook (markdown, typos, style-claims) pass.Generated by Coder Agents on behalf of @nickvigilante.
🤖 Built with AI assistance.