Skip to content

feat: enable Coder.LGBTQ Vale rule - #31181

Merged
nickvigilante merged 1 commit into
mainfrom
superblink/docs-431-add-coderlgbtq-vale-rule
Oct 23, 2026
Merged

nickvigilante merged 1 commit into
mainfrom
superblink/docs-431-add-coderlgbtq-vale-rule

Conversation

@coder

@coder coder Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

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.
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.

Created on behalf of @nickvigilante

@coder
coder Bot requested a review from nickvigilante as a code owner October 23, 2026 08:30
@linear-code

linear-code Bot commented Oct 23, 2026

Copy link
Copy Markdown

DOCS-431

@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Oct 23, 2026
@coder
coder Bot force-pushed the superblink/docs-431-add-coderlgbtq-vale-rule branch from 7b51911 to 4ba5e2c Compare October 23, 2026 08:36
coder Bot pushed a commit that referenced this pull request Oct 23, 2026
Recreated from #30792 under coder[bot] so it can be reviewed by its requester. Stacked on #31181.
@coder
coder Bot changed the base branch from main to superblink/docs-430-add-coderacronymperiods-vale-rule October 23, 2026 08:36
Base automatically changed from superblink/docs-430-add-coderacronymperiods-vale-rule to main October 23, 2026 15:56
nickvigilante added a commit that referenced this pull request Oct 23, 2026
> [!NOTE]
> Recreated from #30783 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
#30783, squashed onto current `main`. Superblink reviewed it and ran
Vale over `docs/` before opening this PR (no new warnings or errors).
#30783 should be closed in favor of this one.
> Stack: this is the bottom of a 6-PR stack (#31180 → #31181 → #31182 →
#31183 → #31184 → #31185). Merge them in that order.

Depends on #30782.

Adds `Coder.AcronymPeriods`, a Vale rule that enforces [No periods in
acronyms](https://github.com/coder/coder/blob/main/docs/.style/style-guide/capitalization-and-punctuation.md#no-periods-in-acronyms).
It flags capitalized acronyms written with periods, such as `A.P.I.` or
`U.S.`.

- Severity: `warning`.
- Scope: `docs/**` except `docs/.style/style-guide/**`, with no other
exclusions.
- Baseline: 0 findings, including the generated
`docs/reference/{api,cli,agent-api}` pages, so no cleanup commit.
- 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 (10 of 87).
- Known limitation: a version placeholder such as X.Y.Z in plain prose
matches as "X.Y.". None exist outside code font today, and the guide
asks for code font on placeholders, which Vale skips.

Linear: DOCS-430

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

- Pattern `\b(?:[A-Z]\.){2,}`. Google.Periods used `{3,}`, but `U.S.` is
a two-letter case the guide's Don't example names, so the rule requires
two or more pairs.
- Google rules aren't loaded, so nothing needed turning off.
- `e.g.` and `i.e.` can't match: the rule is case-sensitive and accepts
capital letters only. A single initial such as `J. Smith` can't match
either.
- Existence rule, `nonword: true`, `ignorecase: false`, same shape as
`UnitSpacing`.
- Test fixtures (not committed) with both LF and CRLF endings:
- Flags: `A.P.I.`, `U.S.`, `E.U.`, and `X.Y.Z` in prose (reported as
`X.Y.`).
- Doesn't flag: `API`, `US`, `e.g.`, `i.e.`, `etc.`, `J. Smith`, `a.m.`,
`p.m.`, code spans, fenced code.
  - LF and CRLF reported identical findings.
- Checks: `vale docs/` reports 0 `Coder.AcronymPeriods` findings, `go
run ./scripts/styleclaims` passes, and the pre-commit-light hook
(markdownlint, emdash, style-claims) 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>
Recreated from #30786 under coder[bot] so it can be reviewed by its requester. Stacked on #31180.
@nickvigilante
nickvigilante force-pushed the superblink/docs-431-add-coderlgbtq-vale-rule branch from 4ba5e2c to 7b1aa58 Compare October 23, 2026 16:01
@nickvigilante
nickvigilante enabled auto-merge (squash) October 23, 2026 16:01
@nickvigilante
nickvigilante merged commit f2edbea into main Oct 23, 2026
29 checks passed
@nickvigilante
nickvigilante deleted the superblink/docs-431-add-coderlgbtq-vale-rule branch October 23, 2026 16:08
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant