-
Notifications
You must be signed in to change notification settings - Fork 324
fix(vale): update (vale sync), improve rules, exclude URLs and shortcode attributes from spell checking #6798
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
5000085 to
75d7c4c
Compare
…ance Spelling improvements: - Exclude fenced code blocks (~code) and inline code (~raw) from checking - Add filters for URL paths, full URLs, and shortcode attributes - Prevents false positives on code syntax and API endpoints Capitalization improvements: - Add InfluxDB product exceptions (InfluxDB, InfluxQL, Telegraf, etc.) - Add common technical acronyms (API, CLI, SQL, HTTP, JSON, etc.) - Add cloud provider names (AWS, GCP, Azure, S3) - Add link to Google style guide for sentence case headings Aligns with Google Developer Documentation Style Guide: https://developers.google.com/style/capitalization https://claude.ai/code/session_0173AuWPoy6UXiatCMGz4W7h
7f8a775 to
7d5898d
Compare
…skill - Disable Vale.Terms to prevent false positives from URLs/paths - Create InfluxDataDocs.Units rule that allows duration literals (30d, 24h) while still validating byte units (GB, TB) - Disable write-good.TooWordy for technical terms (aggregate, expiration) - Add TokenIgnores for URL paths and inline code patterns - Expand spelling ignore list with technical terms (subprocess, CPUs, etc.) - Sync Google style packages via vale sync Documentation improvements: - Add new vale-linting skill with comprehensive workflow - Update content-editing skill with Vale section - Enhance ci-automation-engineer agent with Vale expertise - Add Vale troubleshooting to copilot-instructions.md - Add shell command permissions to settings.json Reduces Vale warnings from 794 to 187 (76% reduction) while keeping useful style validation active.
7d5898d to
43fe85c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the repository’s Vale configuration and rule set to reduce false positives (URLs, paths, Hugo shortcodes, code spans) and adds supporting internal documentation so Vale can be enabled in PR/CI checks with less noise.
Changes:
- Updated
.vale.inito adjust enabled/disabled rules and add globalTokenIgnoresfor URLs/paths/inline code. - Enhanced/customized Vale styles (InfluxDataDocs + synced Google/write-good changes), including a new
InfluxDataDocs.Unitsrule and expanded spelling ignores. - Added internal “vale-linting” workflow documentation and referenced it from existing Copilot/Claude guidance.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| .vale.ini | Adds global ignore patterns and disables select rules (Google.Units, Vale.Terms, write-good.TooWordy). |
| .github/copilot-instructions.md | Updates troubleshooting table and links to the new vale-linting skill doc. |
| .claude/skills/vale-linting/SKILL.md | New comprehensive Vale workflow/how-to document. |
| .claude/skills/content-editing/SKILL.md | Adds a Vale “Style Linting” step and command examples. |
| .claude/settings.json | Expands allowed shell commands (including Vale wrapper and related tooling). |
| .claude/agents/ci-automation-engineer.md | Improves formatting and adds explicit Vale expertise responsibilities. |
| .ci/vale/styles/InfluxDataDocs/Units.yml | Introduces custom units rule to allow InfluxDB duration literals while checking byte units. |
| .ci/vale/styles/InfluxDataDocs/Terms/ignore.txt | Expands spelling ignore list with additional technical terms. |
| .ci/vale/styles/InfluxDataDocs/Spelling.yml | Excludes code/raw/table scopes and adds filters for URLs and shortcode attributes. |
| .ci/vale/styles/InfluxDataDocs/Capitalization.yml | Expands heading capitalization exceptions (products/acronyms/etc.). |
| .ci/vale/styles/Google/Units.yml | Synced Google units token patterns (note: Google.Units is disabled in .vale.ini). |
| .ci/vale/styles/Google/Quotes.yml | Raises severity to error and adjusts message text. |
| .ci/vale/styles/Google/Ordinal.yml | Removes ordinal exceptions (more strict checking). |
| .ci/vale/styles/Google/Colons.yml | Updates regex pattern for colon capitalization detection. |
| .ci/vale/styles/Google/AMPM.yml | Tightens AM/PM regex with word boundaries. |
| .ci/vale/styles/.vale-config/2-Hugo.ini | Adds Hugo-specific ignores for shortcodes/link constructs. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This PR updates and improves vale.sh rules in preparation for enabling Vale to run in PR checks and CI.
Updates vale and extensions
Add filters to prevent false positives on:
URL paths (e.g., /api/v2/write, /kapacitor/v1/api/v2/tasks)
Full URLs (http/https)
Shortcode attribute values (endpoint="...", method="...", etc.)
Add scope exclusions for code blocks (~code) and inline code (~raw) to prevent flagging code syntax.
Disable Vale.Terms to prevent false positives from URLs/paths
Create InfluxDataDocs.Units rule that allows duration literals (30d, 24h)
while still validating byte units (GB, TB)
Disable write-good.TooWordy for technical terms (aggregate, expiration)
Add TokenIgnores for URL paths and inline code patterns
Expand spelling ignore list with technical terms (subprocess, CPUs, etc.)
Sync Google style packages via vale sync
Documentation improvements:
Reduces Vale warnings from 794 to 187 (76% reduction) while keeping style validation active.