Reduce Vale linting issues #492
Merged
Conversation
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
tashian
force-pushed
the
carl/more-vale-fixes
branch
3 times, most recently
from
709e0cc to
7dce48b
Compare
Disable overly strict rules for technical documentation: - write-good.TooWordy (flags "implement", "multiple", "additional") - write-good.Weasel (flags "usually", "various") - Google.Units (requires spaces in Go durations like "168h") - Google.WordList (wants "app" instead of "application", etc.) Fix legitimate issues across 48 files: - Replace "e.g." with "for example" (Google.Latin) - Remove exclamation points (Google.Exclamation) - Rewrite "So..." sentence starters (write-good.So) - Remove first-person pronouns (Google.FirstPerson) - Rewrite "There is/are" starters (write-good.ThereIs) - Fix Smallstep branding Co-Authored-By: Claude Opus 4.5 <[email protected]>
tashian
force-pushed
the
carl/more-vale-fixes
branch
from
7dce48b to
d96e5dd
Compare
Exclamation points are appropriate for congratulatory messages, acknowledgments, and examples that show actual program output. Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Convert 394 Title Case headings to sentence case - Add proper noun and acronym exceptions to Headings.yml - Add YubiKey branding substitutions - Fix repeated word typos (to to, the the, will will, etc.) - Fix heading punctuation (remove trailing periods) - Fix capitalization: ChromeOS, DevOps, ACLs, HSMs, YubiKeys Reduces Vale issues from 696 to 347 (50% reduction). Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Fix Google.OptionalPlurals: change patterns like client(s) to clients - Fix Google.Colons: lowercase text after colons (e.g., "Note: The" → "Note: the") - Disable Google.Slang rule to allow "TL;DR" in technical docs - Skip step-cli/reference/ (auto-generated files) Remaining colon issues are false positives (acronyms like ECDSA, AWS, TLS). Co-Authored-By: Claude Opus 4.5 <[email protected]>
dopey
approved these changes
Feb 3, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR significantly reduces Vale linting issues through a two-phase approach:
Phase 1: Rule configuration (previous commits)
Phase 2: Content fixes (this commit)
Final result
2,659 → 347 issues
Configuration changes
Headings.yml updates:
:and-patternsBranding.yml updates:
Remaining issues (347)
Test plan
vale .and verify reduced issue count🤖 Generated with Claude Code