Add SwitchBot Matter integration page #39730
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation file has been introduced for the SwitchBot Matter integration, detailing its metadata, supported device categories, platforms, and listing compatible SwitchBot Matter devices with relevant links. The documentation specifies integration attributes and provides a reference to the SwitchBot brand website. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistantDocs
User ->> HomeAssistantDocs: Access SwitchBot Matter integration documentation
HomeAssistantDocs -->> User: Display integration metadata and supported devices
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/_integrations/switchbot_matter.markdown (2)
19-19: Use the canonical capitalization forha_iot_standard.Metadata values are case-sensitive. Existing integration pages use
Matter(capital-M) rather thanmatter.-ha_iot_standard: matter +ha_iot_standard: Matter
40-40: Terminate the file with a newline.A trailing newline avoids EOF diff noise and complies with markdown-lint defaults.
-...K20 + Pro](https://www.switch-bot.com/products/switchbot-multitasking-household-robot-k20-pro) \ No newline at end of file +...K20 + Pro](https://www.switch-bot.com/products/switchbot-multitasking-household-robot-k20-pro) +
📜 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/switchbot_matter.markdown(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot_matter.markdown
🪛 LanguageTool
source/_integrations/switchbot_matter.markdown
[grammar] ~31-~31: This phrase is duplicated. You should probably use “SwitchBot Meter” only once.
Context: ...ducts/switchbot-water-leak-detector) - SwitchBot Meter - [SwitchBot Meter Pro](https://www.switch-bot.com/product...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot_matter.markdown
23-23: Bare URL used
null
(MD034, no-bare-urls)
⏰ 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/switchbot_matter.markdown (1)
11-11: Double-check theha_domainvalue.The file slug is
switchbot_matter, yet the front-matter setsha_domain: switchbot.
If the integration’s actual domain isswitchbot_matter, update this field; otherwise leave as-is but consider renaming the file for consistency.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/switchbot_matter.markdown (2)
24-26: Bare-URL lint warning
markdownlintflags the bare URL inside the{% include wwha.md %}asMD034.
Wrap the URL in<…>to silence the linter:-{% include integrations/wwha.md url="https://www.switchbot.com/" %} +{% include integrations/wwha.md url="<https://www.switchbot.com/>" %}
27-42: Template sections missingThe integration-page guideline requires the sections to appear in a fixed order:
## Supported devices ## Configuration ## Entities ## TroubleshootingOnly Supported devices is present. Please add at least empty Configuration and Entities headings (even if they just say “No configuration needed”).
📜 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/switchbot_matter.markdown(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/switchbot_matter.markdown
🪛 LanguageTool
source/_integrations/switchbot_matter.markdown
[grammar] ~33-~33: This phrase is duplicated. You should probably use “SwitchBot Meter” only once.
Context: ...ducts/switchbot-water-leak-detector) - SwitchBot Meter - [SwitchBot Meter Pro](https://www.switch-bot.com/product...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/switchbot_matter.markdown
25-25: Bare URL used
null
(MD034, no-bare-urls)
⏰ 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/switchbot_matter.markdown (1)
1-23: Front-matter: verify required keys & value casingThe YAML block looks mostly correct, but please double-check against the integration-page template:
works_withandha_iot_standardusually take the capitalised valueMatter(notmatter) for consistency with other docs.- Confirm that all mandatory keys (
codeowners,quality_scale, etc.) from the template are present – they appear to be missing here.Failure to match the exact key set / casing can break the docs build.
Proposed change
Add SwitchBot Matter integration page
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit