Customize entity: add step to revert entity ID to default #39495
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for customizing device entity IDs was revised for clarity, updated with consistent icon syntax, and expanded with instructions on reverting entity ID changes. An example was changed, and a new screenshot was added to illustrate the process of reverting all entity IDs for a device. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User->>Documentation: View instructions to customize entity IDs
User->>Documentation: Follow steps to edit or revert entity IDs
Documentation-->>User: Show updated steps with icons and screenshots
User->>Documentation: Learn how to revert all entity IDs for a device
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_docs/configuration/customizing-devices.markdown (2)
19-19: Hyphenate compound adjective for consistency.
Consider updating “top right corner” to “top-right corner” to follow style guidelines for compound adjectives.🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: Consider adding a hyphen.
Context: ...ect the entity from the list. 2. In the top right corner, select the {% icon "mdi:cog" %}...(TOP_LEFT_CORNER)
31-31: Normalize screenshot formatting.
The image block here is indented differently and the alt text isn’t capitalized. Align it with other screenshots and update the alt text:-  + 
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (3)
source/images/docs/configuration/customizing-entity-dialog.pngis excluded by!**/*.pngsource/images/docs/configuration/customizing-entity.pngis excluded by!**/*.pngsource/images/docs/configuration/device-page-revert-entity-id.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_docs/configuration/customizing-devices.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/configuration/customizing-devices.markdown
[uncategorized] ~19-~19: Consider adding a hyphen.
Context: ...ect the entity from the list. 2. In the top right corner, select the {% icon "mdi:cog" %}...
(TOP_LEFT_CORNER)
🔇 Additional comments (3)
source/_docs/configuration/customizing-devices.markdown (3)
24-24: Example entity ID update looks good.
The new examplebinary_sensor.lumi_sensor_aq2_openingis clear and fits the naming conventions.
28-28: Revert step instruction is clear.
The instruction to use the{% icon "mdi:restore" %}icon to undo ID changes is accurate and well-placed.
29-29: “Recreate entity IDs” step is accurate.
The new bullet explaining how to revert all IDs via the three-dots menu aligns with the UI and is helpful.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_docs/configuration/customizing-devices.markdown (1)
34-34: Fix grammatical error in friendly name example
The sentence is missing the noun and the preposition “to”.Proposed diff:
- - In this example, the would change "Opening". + - In this example, the friendly name would change to "Opening".🧰 Tools
🪛 LanguageTool
[grammar] ~34-~34: Did you mean “they”, “that” or “there”?
Context: ... friendly name. - In this example, the would change "Opening". - If needed,...(THE_THEY)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/configuration/customizing-devices.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/configuration/customizing-devices.markdown
[grammar] ~34-~34: Did you mean “they”, “that” or “there”?
Context: ... friendly name. - In this example, the would change "Opening". - If needed,...
(THE_THEY)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_docs/configuration/customizing-devices.markdown (5)
19-19: Explicit icon syntax for consistency
Using{% icon "mdi:cog" %}matches existing documentation conventions and ensures uniformity across guides.
24-24: Example entity ID updated correctly
The new IDbinary_sensor.lumi_sensor_aq2_openingis clear, concise, and follows the naming rules.
28-28: Add instruction to revert to default entity ID
The bullet detailing the{% icon "mdi:restore" %}restore action clearly explains how to undo manual ID edits.
29-29: Add bulk revert option for device entities
The new step for Recreate entity IDs under the three dots menu accurately documents the bulk revert feature.
31-31: New screenshot for reverting all entity IDs
The added image illustrates the bulk revert workflow and aligns with Home Assistant’s visual style.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_docs/configuration/customizing-devices.markdown (2)
29-29: Improve screenshot alt text
Alt text should start with a capital letter and more clearly describe the visual:-  + 
32-32: Fix grammar and missing text
The bullet is missing the subject and the preposition “to”:- - In this example, the would change "Opening". + - In this example, the friendly name would change to "Opening".🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: Did you mean “they”, “that” or “there”?
Context: ... friendly name. - In this example, the would change "Opening". - If needed,...(THE_THEY)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/configuration/customizing-devices.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/configuration/customizing-devices.markdown
[grammar] ~32-~32: Did you mean “they”, “that” or “there”?
Context: ... friendly name. - In this example, the would change "Opening". - If needed,...
(THE_THEY)
🔇 Additional comments (4)
source/_docs/configuration/customizing-devices.markdown (4)
17-17: Explicit icon macro usage for clarity
Using{% icon "mdi:cog" %}ensures consistent syntax across documentation.
22-22: Updated example entity ID
The new examplebinary_sensor.lumi_sensor_aq2_openingis more descriptive and realistic.
26-26: Added instruction to revert single entity ID
Including the restore icon step improves user guidance for undoing ID changes.
27-27: Added instruction to revert all entity IDs
Documenting the Recreate entity IDs option on the device page covers a common use case.
Proposed change
Customize entity:
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit