Repository navigation
feat: enable Coder.InclusiveLanguage Vale rule - #30785
Closed
nickvigilante wants to merge 6 commits into
Closed
nickvigilante wants to merge 6 commits into
nickvigilante wants to merge 6 commits into
Conversation
Add the style rules from the Docs style guide Linear project that the guide was missing, and fix the guide's own self-violations from the second ASD-STE100 audit. Each new Vale rule lands in its own PR based on this one, so every footer for those rules is marked planned. The Vale doctrine now lets suggestion-level rules land with existing findings, per Nick's decision on DOCS-450. Refs DOCS-1282, DOCS-1265
Contributor
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
nickvigilante
force-pushed
the
vigilante/docs-182-add-vale-substitution-rule-for-inclusive-language-industry
branch
from
October 14, 2026 20:53
507e31f to
9db01cd
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
Take main's style guide, which already carries the squashed docs style guide rules, and reapply the InclusiveLanguage footer, checks-table row, and coverage counts on top of main's totals. Main had already reflowed the Agent Firewall use_real_dns bullet, so only the "dummy" to "mock" fix is reapplied there. Assisted-by: AI
nickvigilante
marked this pull request as ready for review
October 23, 2026 05:29
nickvigilante
added a commit
that referenced
this pull request
Oct 23, 2026
> [!NOTE] > Recreated from #30785 under coder[bot] by Superblink, at the request of @nickvigilante, so he can review and merge it. An AI agent wrote the original, which was opened from his account. The diff is identical to #30785, squashed onto current `main`. Superblink reviewed it and ran Vale over `docs/` before opening this PR (no new warnings or errors). #30785 should be closed in favor of this one. > Stack: based on #31182 (#31180 → #31181 → #31182 → #31183 → #31184 → #31185). The diff matches #30785 except for the counters in `docs/.style/style-guide/README.md`, which build on the PRs below this one. `make lint/style-claims` passes at every level. Depends on #30782. Adds `Coder.InclusiveLanguage`, a Vale substitution rule that enforces the [Inclusive-language substitutions](https://github.com/coder/coder/blob/main/docs/.style/style-guide/accessibility-and-inclusion.md#inclusive-language-substitutions) table. - Flags `whitelist`, `blacklist`, `slave`, `master branch`, `master controller`, `dummy`, `sanity check` and `sanity test`, and `grandfathered` and its inflections, with the guide's replacement terms. It also flags inflections such as `whitelisted` and `slaves`. - Severity: `warning`. - Scope: `docs/**` except `docs/.style/style-guide/**` and `docs/reference/cli/agent-firewall.md`. - Baseline: 2 findings, both `dummy`. - `docs/ai-coder/agent-firewall/index.md`: fixed in the cleanup commit (now "mock DNS server", with the bullet reflowed to one sentence per line). - `docs/reference/cli/agent-firewall.md`: generated page. The text comes from the `github.com/coder/boundary` dependency's flag description, so it can't be fixed in this repo. `.vale.ini` turns the rule off for that page, with a comment, and the PR changes no generated output. - After cleanup: 0 findings. - The PR flips the guide footer to enforced, adds the checks-table row, updates the coverage counts (10 tool-checked, 32 planned) and the tooling paragraph, and removes "Inclusive-language substitutions" from the planned list in `docs/.style/styles/Coder/README.md`. Linear: DOCS-182 <details><summary>Decision log</summary> - Bare `master` isn't flagged, as the guide footer says. Only `master branch` and `master controller`, the two senses in the guide table, are. - Replacement wording follows the guide table, not the issue text: `slave` becomes "replica, secondary", `sanity check` becomes "smoke testing, confidence testing, acceptance testing", and `grandfathered` becomes "legacy, pre-existing, exempt". `blacklist` suggests "blocklist, denylist" and `dummy` suggests "placeholder, sample, mock". - Bare `grandfather` isn't flagged, only `grandfather` with an inflection or `clause`. A `grandfather clock` or a family member would otherwise match, and a substitution rule's exceptions can't see the following word. - `white-list` and `white list` forms are covered, along with `-ed` and `-ing` forms for white and blacklist. - Vale skips code spans and fences, so `master` branch names and `dummy` flags in code font are untouched. - Test fixtures (not committed), LF and CRLF, gave identical results: - Flags: every term above and its inflections. - Doesn't flag: `master key`, bare `master`, `mastering`, `grandfather clock`, `sanity` alone, all terms inside code spans and fences, and every recommended replacement. - Checks: `vale docs/` reports 0 `Coder.InclusiveLanguage` findings, `go run ./scripts/styleclaims` passes, and the pre-commit-light hook passes on both commits. </details> *Generated by [Coder Agents](https://coder.com/docs/ai-coder/agents) on behalf of @nickvigilante.* Created on behalf of @nickvigilante Co-authored-by: Nick Vigilante <nick.vigilante@coder.com>
Collaborator
Author
|
Superseded by #31183, which merged the same change into Generated by Coder Agents on behalf of @nickvigilante. |
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.InclusiveLanguage, a Vale substitution rule that enforces the Inclusive-language substitutions table.whitelist,blacklist,slave,master branch,master controller,dummy,sanity checkandsanity test, andgrandfatheredand its inflections, with the guide's replacement terms.It also flags inflections such as
whitelistedandslaves.warning.docs/**exceptdocs/.style/style-guide/**anddocs/reference/cli/agent-firewall.md.dummy.docs/ai-coder/agent-firewall/index.md: fixed in the cleanup commit (now "mock DNS server", with the bullet reflowed to one sentence per line).docs/reference/cli/agent-firewall.md: generated page.The text comes from the
github.com/coder/boundarydependency's flag description, so it can't be fixed in this repo..vale.initurns the rule off for that page, with a comment, and the PR changes no generated output.docs/.style/styles/Coder/README.md.Linear: DOCS-182
Decision log
masterisn't flagged, as the guide footer says. Onlymaster branchandmaster controller, the two senses in the guide table, are.slavebecomes "replica, secondary",sanity checkbecomes "smoke testing, confidence testing, acceptance testing", andgrandfatheredbecomes "legacy, pre-existing, exempt".blacklistsuggests "blocklist, denylist" anddummysuggests "placeholder, sample, mock".grandfatherisn't flagged, onlygrandfatherwith an inflection orclause. Agrandfather clockor a family member would otherwise match, and a substitution rule's exceptions can't see the following word.white-listandwhite listforms are covered, along with-edand-ingforms for white and blacklist.masterbranch names anddummyflags in code font are untouched.master key, baremaster,mastering,grandfather clock,sanityalone, all terms inside code spans and fences, and every recommended replacement.vale docs/reports 0Coder.InclusiveLanguagefindings,go run ./scripts/styleclaimspasses, and the pre-commit-light hook passes on both commits.Generated by Coder Agents on behalf of @nickvigilante.