Add rule to flag id-for-anchoring placeholder#93
Merged
Conversation
Flags the literal id-for-anchoring placeholder text from the collapse-content shortcode template so writers replace it with a unique, descriptive ID before merging. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Adds a Vale rule that flags the literal
id-for-anchoringplaceholder text. This placeholder comes from thecollapse-contentshortcode template and is meant to be replaced by writers with a unique, descriptive ID for the expander. When left in place, anchor links to the section don't work and multiple expanders on the same page collide on the same ID.Recent instances of the placeholder slipping through to merged docs: documentation#36760 cleaned up 22 of them across 10 pages.
The rule uses the same
existencepattern asmerge_conflict.yml— a harderrorlevel for a token that should never appear in published content.Test plan
id="id-for-anchoring"and confirm the rule fires with the expected message.