Skip to content

docs: fix GerundHeading, Semicolons, and UnitSpacing findings - #31877

Closed
coder[bot] wants to merge 1 commit into
mainfrom
docs/vale-warning-fixes
Closed

coder[bot] wants to merge 1 commit into
mainfrom
docs/vale-warning-fixes

Conversation

@coder

@coder coder Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Fixes the warning-level findings that the Vale findings spike review marked valid:

  • Coder.GerundHeading: docs/.style/styles/Coder/README.md, "Authoring a new rule" is now "Author a new rule". Nothing links to the old anchor.
  • Coder.Semicolons: templates/extending-templates/docker-in-workspaces.md. Each semicolon is now a sentence break, with the new sentence on its own line.
  • Coder.UnitSpacing: added   between number and unit in get-started/index.md (10 minutes), mcp-server.md (5 minutes), ai-governance/ai-gateway/setup.md (60 days), and reference/feature-stages.md (60 seconds).

These three rules now have 0 findings in vale docs/, and the changed files have no new findings from other rules.


AI-generated by Superblink on behalf of @nickvigilante.

@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Nov 6, 2026
- Product-voice rules

## Authoring a new rule
## Author a new rule

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a mechanism to store additional header IDs per header. We previously used an empty <a> tag, but axe flagged that as bad practice. I know Quarto and other flavors of Markdown support appending { #new-header-id } to this line to add custom IDs. Is that possible with our new docs?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not with the current docs engine:

  • Each heading gets exactly one ID: the GitHub slug of its text (remarkClassicHeadingIds in coder/docs-engine).
  • Fumadocs' [#id] syntax is turned off. The only custom form the engine honors is the [#step-n-title] [step] ID that the sync writes for step headings.
  • Pandoc/Quarto { #id } isn't parsed, so it would show up as literal heading text. GitHub doesn't render it either.
  • The sanitizer adds a user-content- prefix to raw HTML IDs, so an empty <span id="..."> wouldn't match the fragment either.

Keeping old anchors would take a docs-engine change, such as honoring [#id] as an alias or adding an anchor-alias list in front matter.

For this PR, nothing in the repo links to #authoring-a-new-rule, so the rename is safe.

@nickvigilante

Copy link
Copy Markdown
Collaborator

Closing and reopening under a human author, as required for this repository.

@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:54 — with GitHub Actions Inactive
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:54 — with GitHub Actions Inactive
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 10, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive

This branch was previously deployed

1 inactive deployment
main — 206fa851 Deployed Nov 10, 2026 by nickvigilante via cla #253481
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