Skip to content

feat: enable Coder.LGBTQ Vale rule - #30786

Closed
nickvigilante wants to merge 5 commits into
mainfrom
vigilante/docs-431-add-coderlgbtq-vale-rule
Closed

nickvigilante wants to merge 5 commits into
mainfrom
vigilante/docs-431-add-coderlgbtq-vale-rule

Conversation

@nickvigilante

Copy link
Copy Markdown
Collaborator

Depends on #30782.

Adds Coder.LGBTQ, a Vale substitution rule that enforces Inclusive LGBTQ terms.
It flags outdated terms for sex, gender, and sexual orientation, and suggests the current term.

  • Severity: warning.
  • Scope: docs/** except docs/.style/style-guide/**, with no other exclusions.
  • Baseline: 0 findings, including generated pages, so no cleanup commit.
  • Adapted from the alex LGBTQ.yml list.
    alex is MIT licensed (Copyright (c) 2020 errata.ai), and the YAML header carries the attribution and a list of changes.
  • The rule covers every row of the guide table, and none of the guide's recommended terms trigger it.
  • The PR flips the guide footer to enforced, adds the checks-table row, and updates the coverage counts (10 tool-checked, 32 planned) and the tooling paragraph.

Linear: DOCS-431

Decision log
  • Upstream verified at errata-ai/alex alex/LGBTQ.yml, MIT license. /tmp draft matched upstream.
  • Removed bi, because it flags "Power BI".
  • Removed special rights, because permissions docs could use it as a plain technical phrase.
  • Removed homo, because it flags "Homo sapiens".
  • Added a transgender from the guide table.
    It matches only when followed by is, was, who, and, or, but, that, has, had, can, will, would, or should, so a transgender person and a transgender woman stay clean.
    A noun use followed by punctuation (Ask a transgender.) isn't caught.
  • preferred pronouns, transgendered, gender pronouns, biologically female, born a man, genetically male, and hermaphrodite come from upstream.
  • homosexual is flagged in any use, as upstream does, which is stricter than the guide's "as a noun".
  • Upstream's | separator in suggestions became ", ", the form the other Coder substitution rules use.
  • Test fixtures (not committed), LF and CRLF, gave identical results:
    • Flags: every guide Don't term, plus the homosexual compounds, sexual preference, sex change, bathroom bill, transgenders.
    • Doesn't flag: Power BI, bi-directional, bi-weekly, homogeneous, special rights, the guide's Do terms, a transgender person, a transgender woman, and terms inside code spans and fences.
  • Checks: vale docs/ reports 0 Coder.LGBTQ findings, go run ./scripts/styleclaims passes, and the pre-commit-light hook passes.

Generated by Coder Agents on behalf of @nickvigilante.

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
@linear-code

linear-code Bot commented Oct 14, 2026

Copy link
Copy Markdown

DOCS-431

@nickvigilante
nickvigilante force-pushed the vigilante/docs-431-add-coderlgbtq-vale-rule branch from f83096e to cfab121 Compare October 14, 2026 20:54
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 LGBTQ footer, checks-table row,
and coverage counts on top of main's totals.

Assisted-by: AI
@nickvigilante
nickvigilante marked this pull request as ready for review October 23, 2026 05:29
coder Bot pushed a commit that referenced this pull request Oct 23, 2026
Recreated from #30786 under coder[bot] so it can be reviewed by its requester. Stacked on #31180.
nickvigilante added a commit that referenced this pull request Oct 23, 2026
Recreated from #30786 under coder[bot] so it can be reviewed by its requester. Stacked on #31180.
nickvigilante added a commit that referenced this pull request Oct 23, 2026
> [!NOTE]
> Recreated from #30786 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
#30786, squashed onto current `main`. Superblink reviewed it and ran
Vale over `docs/` before opening this PR (no new warnings or errors).
#30786 should be closed in favor of this one.
> Stack: based on #31180 (#31180 → #31181 → #31182 → #31183 → #31184 →
#31185). The diff matches #30786 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.LGBTQ`, a Vale substitution rule that enforces [Inclusive
LGBTQ
terms](https://github.com/coder/coder/blob/main/docs/.style/style-guide/accessibility-and-inclusion.md#inclusive-lgbtq-terms).
It flags outdated terms for sex, gender, and sexual orientation, and
suggests the current term.

- Severity: `warning`.
- Scope: `docs/**` except `docs/.style/style-guide/**`, with no other
exclusions.
- Baseline: 0 findings, including generated pages, so no cleanup commit.
- Adapted from the [alex](https://github.com/errata-ai/alex) `LGBTQ.yml`
list.
alex is MIT licensed (Copyright (c) 2020 errata.ai), and the YAML header
carries the attribution and a list of changes.
- The rule covers every row of the guide table, and none of the guide's
recommended terms trigger it.
- The PR flips the guide footer to enforced, adds the checks-table row,
and updates the coverage counts (10 tool-checked, 32 planned) and the
tooling paragraph.

Linear: DOCS-431

<details><summary>Decision log</summary>

- Upstream verified at `errata-ai/alex` `alex/LGBTQ.yml`, MIT license.
`/tmp` draft matched upstream.
- Removed `bi`, because it flags "Power BI".
- Removed `special rights`, because permissions docs could use it as a
plain technical phrase.
- Removed `homo`, because it flags "Homo sapiens".
- Added `a transgender` from the guide table.
It matches only when followed by `is`, `was`, `who`, `and`, `or`, `but`,
`that`, `has`, `had`, `can`, `will`, `would`, or `should`, so `a
transgender person` and `a transgender woman` stay clean.
A noun use followed by punctuation (`Ask a transgender.`) isn't caught.
- `preferred pronouns`, `transgendered`, `gender pronouns`,
`biologically female`, `born a man`, `genetically male`, and
`hermaphrodite` come from upstream.
- `homosexual` is flagged in any use, as upstream does, which is
stricter than the guide's "as a noun".
- Upstream's `|` separator in suggestions became ", ", the form the
other Coder substitution rules use.
- Test fixtures (not committed), LF and CRLF, gave identical results:
- Flags: every guide Don't term, plus the `homosexual` compounds,
`sexual preference`, `sex change`, `bathroom bill`, `transgenders`.
- Doesn't flag: `Power BI`, `bi-directional`, `bi-weekly`,
`homogeneous`, `special rights`, the guide's Do terms, `a transgender
person`, `a transgender woman`, and terms inside code spans and fences.
- Checks: `vale docs/` reports 0 `Coder.LGBTQ` findings, `go run
./scripts/styleclaims` passes, and the pre-commit-light hook passes.

</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>
@nickvigilante

Copy link
Copy Markdown
Collaborator Author

Superseded by #31181, which merged the same change into main as part of the stacked Vale rule PRs. Closing as a duplicate.

Generated by Coder Agents on behalf of @nickvigilante.

@github-actions github-actions Bot locked and limited conversation to collaborators Oct 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant