Use component and platform for link id in configuration blocks #40123
Conversation
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
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the uniqueness of configuration block anchor links by prefixing them with component and platform identifiers. Instead of all configuration blocks having the generic ID configuration-variables, they now include component and platform names when available, creating more specific and unique anchor links throughout the documentation.
- Updates all configuration block calls in the template integration documentation to include specific identifiers
- Modifies the configuration plugin to generate unique link IDs by combining component, platform, and 'configuration-variables'
- Ensures better navigation and linking within documentation pages that contain multiple configuration sections
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| source/_integrations/template.markdown | Updates configuration block tags to include specific component/platform identifiers for unique anchor generation |
| plugins/configuration.rb | Modifies link ID generation logic to create unique anchors using component and platform prefixes |
Comments suppressed due to low confidence (1)
c0ffeeca7
approved these changes
Jul 24, 2025
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.
Proposed change
configuration-variables. With this change it prefixes component and platform if available to generate more unique ids.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.