Add data update details for Shelly integration #38852
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Shelly integration was updated by adding a new "Data updates" section, which explains how Shelly devices communicate updates to Home Assistant. Existing configuration instructions for generation 1 and generation 2+ devices were reorganized under new subheadings within this section. Two new subsections were included to list entities that are disabled by default and rely on polling every 60 seconds, with separate lists for generation 1 and generation 2+ devices. No changes were made to code or public APIs. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation structure and content. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolsource/_integrations/shelly.markdown[grammar] ~99-~99: You’ve repeated a verb. Did you mean to only write one of them? (REPEATED_VERBS) [uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) [grammar] ~108-~108: You’ve repeated a verb. Did you mean to only write one of them? (REPEATED_VERBS) ⏰ Context from checks skipped due to timeout of 90000ms (3)
🔇 Additional comments (3)
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 (5)
source/_integrations/shelly.markdown (5)
65-67: Fix grammar and add link to developer docs
"devices needs" should be "devices need" for correct subject-verb agreement. Also, consider linking to the official Data update rules page to guide integrators:@@ 67 -For push updates to work correctly some devices needs additional configuration: +For push updates to work correctly some devices need additional configuration. +For more details, see [Data update rules](https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-data-update).
97-97: Correct plural verb usage in heading
Use "poll" instead of "polls" since "entities" is plural:-### Shelly entities that polls data from the device (generation 1) +### Shelly entities that poll data from the device (generation 1)🧰 Tools
🪛 LanguageTool
[grammar] ~97-~97: Possible subject-verb agreement error.
Context: ...{% endnote %} ### Shelly entities that polls data from the device (generation 1) Th...(NNS_THAT_AGREEMENT)
99-99: Improve phrasing and hyphenation
Streamline the sentence and hyphenate the compound adjective:-The following disabled by default entities {% term polling polls %} data from the device every 60 seconds: +The following disabled-by-default entities poll data from the device every 60 seconds:🧰 Tools
🪛 LanguageTool
[grammar] ~99-~99: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling polls %} data from the device every 60 second...(REPEATED_VERBS)
106-106: Correct plural verb usage in heading
Apply the same plural correction for generation 2+:-### Shelly entities that polls data from the device (generation 2+) +### Shelly entities that poll data from the device (generation 2+)🧰 Tools
🪛 LanguageTool
[grammar] ~106-~106: Possible subject-verb agreement error.
Context: ...rmware update ### Shelly entities that polls data from the device (generation 2+) T...(NNS_THAT_AGREEMENT)
108-108: Improve phrasing and hyphenation
Mirror the fix for the generation 2+ polling description:-The following disabled by default entities {% term polling polls %} data from the device every 60 seconds: +The following disabled-by-default entities poll data from the device every 60 seconds:🧰 Tools
🪛 LanguageTool
[grammar] ~108-~108: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling polls %} data from the device every 60 second...(REPEATED_VERBS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/shelly.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/shelly.markdown
[grammar] ~97-~97: Possible subject-verb agreement error.
Context: ...{% endnote %} ### Shelly entities that polls data from the device (generation 1) Th...
(NNS_THAT_AGREEMENT)
[grammar] ~99-~99: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling polls %} data from the device every 60 second...
(REPEATED_VERBS)
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ta from the device every 60 seconds: - Cloud connected sensor - RSSI sensor - Uptime sensor - ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~106-~106: Possible subject-verb agreement error.
Context: ...rmware update ### Shelly entities that polls data from the device (generation 2+) T...
(NNS_THAT_AGREEMENT)
[grammar] ~108-~108: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling polls %} data from the device every 60 second...
(REPEATED_VERBS)
⏰ 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 (1)
source/_integrations/shelly.markdown (1)
86-86: Configuration section nesting is correct
The "Shelly device configuration (generation 2+)" subsection is properly nested under the new Data updates section with the correct heading level.
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/shelly.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/shelly.markdown
[grammar] ~99-~99: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling poll %} data from the device every 60 second...
(REPEATED_VERBS)
[uncategorized] ~101-~101: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ta from the device every 60 seconds: - Cloud connected sensor - RSSI sensor - Uptime sensor - ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~108-~108: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ng disabled by default entities {% term polling poll %} data from the device every 60 second...
(REPEATED_VERBS)
🔇 Additional comments (1)
source/_integrations/shelly.markdown (1)
86-86: Heading structure for Generation 2+ configuration is clear
The “### Shelly device configuration (generation 2+)” section mirrors the generation 1 subsection and requires no changes.
Proposed change
Describe how Shelly updates data from devices docs-data-update
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit