You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
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
This PR cleans up the action documentation across multiple integrations to follow a consistent pattern.
What was changed
Updated action headings to the### Action \`domain.action_name` format (e.g.### Action `abode.change_setting`instead of### Action: Change setting or bare`blink.record`).
Ensured each integration uses the full namespaced action ID in headings and “available actions” lists (for exampleamcrest.enable_audio,aftership.add_tracking,guardian.upgrade_firmware, etc.). It wasn't my main goal, but if I noticed a problem, I corrected it.
Added or normalized## Actions sections where they were missing or inconsistent.
Updated the integration docs template and Copilot instructions so new docs follow the same convention.
Why
Makes it easier for users to copy-paste the correct action ID directly from the docs into automations/scripts.
Aligns existing integration pages with the current action naming conventions used in Home Assistant.
Reduces confusion between generic section titles and the actual action IDs exposed by integrations.
Improved scalability and navigation: using a consistentAction `domain.id` heading format makes it easier to search for a specific action (both for users and tooling), to link directly to it, and to keep a growing set of actions maintainable.
Future improvements
The additional reason for standardizing these headings now is to unlock better automation later. With a consistent### Action \domain.action_name `` pattern, it becomes feasible to add CI checks that verify the code and documentation stay in sync (e.g., every exposed action has a corresponding section).
Those checks arenot part of this PR, but the unified headings make it easier in future.
Type of change
Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
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.
c0ffeeca7 left a comment
Proposed change
This PR cleans up the action documentation across multiple integrations to follow a consistent pattern.
What was changed
### Action \`domain.action_name`format (e.g.### Action `abode.change_setting`instead of### Action: Change settingor bare`blink.record`).amcrest.enable_audio,aftership.add_tracking,guardian.upgrade_firmware, etc.). It wasn't my main goal, but if I noticed a problem, I corrected it.## Actionssections where they were missing or inconsistent.Why
Action `domain.id`heading format makes it easier to search for a specific action (both for users and tooling), to link directly to it, and to keep a growing set of actions maintainable.Future improvements
The additional reason for standardizing these headings now is to unlock better automation later.
With a consistent
### Action \domain.action_name `` pattern, it becomes feasible to add CI checks that verify the code and documentation stay in sync (e.g., every exposed action has a corresponding section).Those checks arenot part of this PR, but the unified headings make it easier in future.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.