Update Songpal documentation to include newly exposed settings #39656
Conversation
…e-assistant#39626) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…39648) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…e-assistant#39649) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe changes update documentation for several integrations and device customization, clarify instructions, and improve user guidance. A new troubleshooting section is added for Onkyo, Songpal documentation is expanded, and HELTUN integration details are revised. Additionally, a conditional rendering fix is applied to a partner program snippet, and the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant UI
User->>Docs: Reads device customization instructions
Docs->>User: Shows steps for editing/reverting entity IDs
User->>UI: Attempts to revert entity ID
UI->>User: Checks eligibility, shows restore/reset option or error
User->>Docs: Reads troubleshooting for Onkyo
Docs->>User: Suggests power cycling receiver if no entities appear
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 (3)
source/_integrations/songpal.markdown (1)
45-48: Refine punctuation in actions note
Add a comma after “compatibility purposes” for readability:- For backwards compatibility purposes the integration provides actions... + For backwards compatibility purposes, the integration provides actions...source/_docs/configuration/customizing-devices.markdown (1)
30-36: Fix subject–verb agreement and article usage
- Change “depends” to “depend” to match plural “terms.”
- Remove the extra “the” in “If the something other than Latin script…”
- The terms used to generate the entity ID depends on a few factors. + The terms used to generate the entity ID depend on a few factors. - If the something other than Latin script is used, the entity ID is based on the English default name. + If something other than Latin script is used, the entity ID is based on the English default name.source/_integrations/heltun.markdown (1)
24-24: Improve readability by splitting the run-on sentence.The description at line 24 is a comma splice and can be hard to follow. Consider splitting it into two sentences or bullet points. For example:
-[HELTUN](https://www.heltun.com/) thermostats make it easy to automate your heating system, their touch panel switches control your lighting and motorized appliances and their high load switches control any high load appliances like groups of lights, heaters, or individual sockets. +[HELTUN](https://www.heltun.com/) thermostats make it easy to automate your heating system. Their touch panel switches control your lighting and motorized appliances, and their high load switches manage any high-load devices such as groups of lights, heaters, or individual sockets.
📜 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)
Gemfile.lockis excluded by!**/*.locksource/images/docs/configuration/customizing-entity-dialog.pngis excluded by!**/*.pngsource/images/docs/configuration/customizing-entity.pngis excluded by!**/*.png
📒 Files selected for processing (6)
Gemfile(1 hunks)source/_docs/configuration/customizing-devices.markdown(1 hunks)source/_includes/integrations/wwha.md(1 hunks)source/_integrations/heltun.markdown(1 hunks)source/_integrations/onkyo.markdown(1 hunks)source/_integrations/songpal.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/songpal.markdown
[typographical] ~41-~41: If the word ‘Which’ starts a question, add a question mark (“?”) at the end of the sentence.
Context: ... your specific Songpal compatible device. ## Actions For backwards compatibilit...
(WHAT_NOUNPHRASE_QUESTION_MARK)
[uncategorized] ~45-~45: A comma might be missing here.
Context: ...## Actions For backwards compatibility purposes the integration provides actions for ma...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
⏰ 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 (9)
Gemfile (1)
15-15: Bumpruby-lspto latest patch version
Updating the development group to0.24.2aligns with the upstream release.source/_integrations/onkyo.markdown (1)
110-115: Add concise troubleshooting step
The new “## Troubleshooting” section with a “No entities created” tip is clear and follows existing documentation patterns.source/_integrations/songpal.markdown (2)
12-12: Add codeowner for consistency
Including@YoshiWalshunderha_codeownersmatches the PR objective and aligns with other integrations.
37-42: Clarify new Entities section
The “Entities” section clearly explains the newly exposed settings entities and encourages migration from actions.source/_docs/configuration/customizing-devices.markdown (3)
17-17: Clarify UI interaction step
Step 2 clearly describes selecting the cog icon in the entity dialog.
25-29: Enhance revert instructions
The added bullets for resetting individual IDs and recreating all entity IDs improve usability guidance.
41-41: Confirm friendly name example
The example clarifies what changing the friendly name entails.source/_includes/integrations/wwha.md (1)
20-20: Implement conditional partner link rendering
The new check ensures names without URLs render as plain text, aligning behaviour across integrations.source/_integrations/heltun.markdown (1)
26-26: Consistent partner program include.Using the
wwha.mdsnippet here standardizes partner program mentions across integrations.
Proposed change
Updates documentation to reflect changes in home-assistant/core#147217.
The integration now provides entities to indicate the status of and allow changing various integerTarget, stringTarget, booleanTarget, and enumTarget. This should include all settings that were previously modifiable via the set_sound_settings action, so I have added a recommendation to no longer use this action.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Documentation
Chores