Skip to content

docs: cut Coder.AbbreviationFirstUse false positives - #31874

Merged
nickvigilante merged 1 commit into
mainfrom
docs/vale-abbreviation-feedback
Nov 6, 2026
Merged

nickvigilante merged 1 commit into
mainfrom
docs/vale-abbreviation-feedback

Conversation

@coder

@coder coder Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Addresses the Coder.AbbreviationFirstUse rows from the Vale findings spike review. Only rows that got a verdict or a note are acted on.

Rule exceptions

Added to docs/.style/styles/Coder/AbbreviationFirstUse.yml:

Terms Why
UUID, TTL, UTC, CI, GPU, LLM, SSO Marked false positive: industry-standard terms
JWT, RFC, NTP Marked unsure, leaning toward an exception (NTP is also linked out on its page)
DERP, OIDC, STUN "Define it once globally": the glossary now defines all three (added a STUN entry)
EC2, RDS AWS product names (Amazon RDS is also linked out)

The style guide's abbreviation section now says glossary-defined terms can join the list.

Docs fixes

  • Expanded on first use: MCP (bring-your-own-mcp-servers.md, migrate-from-ona.md), SCIM, CA, IAM (migrate-from-ona.md), SIEM (agent-relay/monitoring/index.md), RBAC (agent-relay/setup.md).
  • agent-relay/claude-code.md: "a Slack DM with Claude" is now "a direct message to Claude in Slack". I didn't use plain "Slack message" because a channel tag is also a Slack message, and the docs treat that as a different session type.

Not changed

Rows marked unsure without a note: DM on agent-relay/slack.md (6) and agent-relay/troubleshooting.md (1), and VPC on migrate-from-ona.md. Those 8 findings still fire.

vale docs/ for this rule goes from 70 warnings to 8. The changed pages have no new findings from other rules.


AI-generated by Superblink on behalf of @nickvigilante.

Add industry-standard and glossary-defined abbreviations to the rule exceptions, and expand the remaining abbreviations on first use, following the Vale spike review.
@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Nov 6, 2026
@nickvigilante nickvigilante changed the title fix(docs/.style): cut Coder.AbbreviationFirstUse false positives docs: cut Coder.AbbreviationFirstUse false positives Nov 6, 2026
@nickvigilante
nickvigilante marked this pull request as ready for review November 6, 2026 21:51
@nickvigilante
nickvigilante merged commit a84f567 into main Nov 6, 2026
55 of 57 checks passed
@nickvigilante
nickvigilante deleted the docs/vale-abbreviation-feedback branch November 6, 2026 21:52
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 6, 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