Use common WWHA doc structure for Third Reality #39579
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new shared markdown include file was introduced to standardize integration descriptions for the "Works with Home Assistant" program. The Third Reality integration documentation was updated to use this include, replacing its detailed content with a templated summary generated by the new snippet. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistantDocs
participant WWHAInclude
User ->> HomeAssistantDocs: Request Third Reality integration page
HomeAssistantDocs ->> WWHAInclude: Render integration description (with protocols, URL)
WWHAInclude -->> HomeAssistantDocs: Return standardized summary with badges and links
HomeAssistantDocs -->> User: Serve rendered integration documentation
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/_includes/integrations/wwha.md (2)
4-18: Simplify list formatting with Liquid filters.The manual loop and string appends work but can be streamlined using Liquid’s
array_to_sentence_string(or a combination ofmap/join) to handle commas and “and” logic in one go. This will reduce boilerplate and improve readability.
47-47: Ensure file ends with a newline.Add a trailing newline to satisfy POSIX conventions and avoid potential parser issues.
source/_integrations/third_reality.markdown (1)
31-31: Leverage shared WWHA include; suppress bare-URL lint warning.The include replaces verbose content nicely. To avoid MD034 (
no-bare-urls) on the raw URL, wrap it in angle brackets or disable the rule locally:<!-- markdownlint-disable MD034 --> {% include integrations/wwha.md url="https://3reality.com/" %} <!-- markdownlint-enable MD034 -->
📜 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 (2)
source/_includes/integrations/wwha.md(1 hunks)source/_integrations/third_reality.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/third_reality.markdown
31-31: Bare URL used
null
(MD034, no-bare-urls)
🪛 LanguageTool
source/_includes/integrations/wwha.md
[grammar] ~6-~6: Did you mean “Z-Wave” (= wireless protocol)?
Context: ..._with %} {% case type %} {% when "zwave" %}{% assign formatted_type = "Z-Wave" ...
(Z_WAVE)
[grammar] ~22-~22: Did you mean “Z-Wave” (= wireless protocol)?
Context: ...stant. {% if page.works_with contains "zwave" %} {{ name }} Z-Wave devices work lo...
(Z_WAVE)
[grammar] ~25-~25: Did you mean “Z-Wave” (= wireless protocol)?
Context: ...stantly in Home Assistant. {% my add_zwave_device badge domain=page.ha_domain %} ...
(Z_WAVE)
⏰ 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/_includes/integrations/wwha.md (5)
1-3: Correctly capturing integration name and URL.The
capturetags with a sensible default forinclude.nameensure flexibility and prevent errors whennameisn’t passed.
20-20: Approve lead paragraph output.The templated sentence cleanly injects
name,url, and the aggregatedformatted_types, ensuring consistent wording across integrations.
22-29: Approve Z-Wave conditional section.The Z-Wave block correctly checks
page.works_with, uses the badge helper, and maintains proper “Z-Wave” spelling.
31-38: Approve Zigbee conditional section.The Zigbee block mirrors the Z-Wave pattern, correctly handling badges and links.
40-46: Approve Matter conditional section.The Matter section follows the established pattern and correctly integrates badges and documentation links.
Proposed change
This moves the common text we use for WWHA to a common file, so that we can just include it.
Updated Third Reality as a trial. I'll update the rest in follow-up PRs.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit