fix(ci): Vale flagging MDX custom heading-ID comments as prose#4833
Merged
Conversation
Headings like '## Highly available Worker patterns {/* #ha-worker-patterns */}'
were being scanned as prose, so kebab-case anchor slugs (e.g.
'ha-worker-patterns') tripped Temporal.terms whenever they happened to
contain a lowercase Temporal term substring. This pattern is used in
315 files. Add a TokenIgnores rule to exclude MDX comment syntax
({/* ... */}) from both Temporal rules.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview linksThis PR does not change any pages in /docs. If you make updates, links to the modified pages will appear here. |
lennessyy
changed the title
lennessyy
changed the title
Duncanma
approved these changes
Jul 7, 2026
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
## Highly available Worker patterns {/* #ha-worker-patterns */}, were being scanned as prose by Valeha-worker-patterns) tripTemporal.termswhenever they happen to contain a lowercase Temporal term substring (e.g. "worker")TokenIgnoresrule to.vale-ci.iniexcluding MDX comment syntax ({/* ... */}) from bothTemporal.termsandTemporal.HeadingsTest plan
## Highly available Worker patterns {/* #ha-worker-patterns */}) no longer flagsvale/test/regression suite — no change in existing findingsdocs/encyclopedia/temporal.mdx)┆Attachments: EDU-6663 Fix Vale flagging MDX custom heading-ID comments as prose