Rephrase in positive form in General recommendations #39335
Conversation
"General recommendations" contains a confusing series of sentences contained in the first bullet point: > Using Thread-based Matter [...] requires Home Assistant OS[...]. Not > using Home Assistant OS is at your own risk. This is ambiguous: - Is using Home Assistant OS required if there is another path, albeit a risky one? Or is HA OS the supported path, but not the required path? - Is using anything other than Home Assistant OS "at your own risk" for Thread-based Matter? Matter? Or in general? The Strunk and White recommendation for this class of problem is "Put statements in positive form." I've attempted to rephrase this recommendation in positive form and remove the ambiguity, but I may have gotten it wrong.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe troubleshooting documentation for Matter integration in Home Assistant was updated to clarify that only Home Assistant OS with the Matter Server add-on is officially supported for Thread-based Matter devices, while running Matter Server as a standalone Docker container is unsupported. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates. 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 (1)
source/_integrations/matter.markdown (1)
390-390: Consider consolidating the supported installation guidance for clarity.The two sentences repeat “Home Assistant OS” and “Matter” back-to-back. Merging them can streamline the message:
Run Home Assistant OS 10+ with the Matter Server add-on to use Thread-based Matter devices; running the Matter Server as a standalone Docker container is unsupported. For host and networking requirements, see the [Matter server docs].
📜 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/_integrations/matter.markdown(1 hunks)
⏰ 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
Proposed change
"General recommendations" contains a confusing series of sentences contained in the first bullet point:
This is ambiguous:
The Strunk and White recommendation for this class of problem is "Put statements in positive form." I've attempted to rephrase this recommendation in positive form and remove the ambiguity, but I may have gotten it wrong (since I don't know for sure the answers to the questions above, this is my best guess).
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
NA
Checklist
currentbranch.nextbranch.(aside: Microsoft Style Guide referred to in the Home Assistant documentation standards says, "Phrase statements in the positive form, and emphasize what users can accomplish, rather than what they can't."—bonus points!)
Summary by CodeRabbit