Repository navigation
docs: fix GerundHeading, Semicolons, and UnitSpacing findings - #31877
Closed
coder[bot] wants to merge 1 commit into
Closed
coder[bot] wants to merge 1 commit into
coder[bot] wants to merge 1 commit into
Conversation
| - Product-voice rules | ||
|
|
||
| ## Authoring a new rule | ||
| ## Author a new rule |
Collaborator
There was a problem hiding this comment.
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?
Contributor
Author
There was a problem hiding this comment.
Not with the current docs engine:
- Each heading gets exactly one ID: the GitHub slug of its text (
remarkClassicHeadingIdsincoder/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.
Collaborator
|
Closing and reopening under a human author, as required for this repository. |
This branch was previously deployed
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.
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 inget-started/index.md(10 minutes),mcp-server.md(5 minutes),ai-governance/ai-gateway/setup.md(60 days), andreference/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.