Skip to content

Clean up home automation page#335

Open
ekcom wants to merge 3 commits into
wled:mainfrom
ekcom:patch-2
Open

Clean up home automation page#335
ekcom wants to merge 3 commits into
wled:mainfrom
ekcom:patch-2

Conversation

@ekcom

@ekcom ekcom commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Fix grammar; improve organization

Summary by CodeRabbit

  • Documentation
    • Improved the Home Automation guide’s introductory wording and cleaned up minor punctuation/spacing.
    • Reorganized the post-MQTT resources into a clearer structure, including a dedicated openHAB section and a new “Other” section for related setup links.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Minor punctuation fix in the intro ("3rd-party") and restructuring of the home automation page's tail sections: standalone "Indigo Domotics" and "openHAB" entries are replaced with a dedicated openHAB section and a new "Other" section grouping Home Assistant/NodeRED, Domoticz, and Indigo Domotics as bullets.

Changes

Home Automation Docs Restructure

Layer / File(s) Summary
Intro fix and section consolidation
docs/advanced/home-automation.md
Punctuation corrected in intro text; standalone openHAB and Indigo Domotics sections replaced with an openHAB section and an "Other" bullet list grouping HomeAssistant/NodeRED, Domoticz, and Indigo Domotics.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit tidied up the docs one day,
Grouped the links in a neater way,
openHAB got its own little space,
Others huddled in a bulleted place,
Hop hop hooray for tidy displays! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation cleanup and reorganization of the home automation page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (3)
docs/advanced/home-automation.md (3)

142-142: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Fix "Openhab" capitalization to "openHAB".

Line 142 uses "Openhab" which is inconsistent with the standard "openHAB" branding used elsewhere on this page (lines 138, 140) and in the home automation community. This hurts readability and looks unprofessional.

As per coding guidelines, use consistent, correct capitalization for API and project names. Based on learnings, ensure programming language names and API datatype names use consistent, correct capitalization.

-For older openHAB (2.5.x) environments, the connection can be configured via MQTT broker & Openhab MQTT Binding (2.5x) with configuration files.
+For older openHAB (2.5.x) environments, the connection can be configured via MQTT broker & openHAB MQTT Binding (2.5x) with configuration files.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/advanced/home-automation.md` at line 142, The branding in the home
automation docs is inconsistent: the sentence in the openHAB configuration
section uses “Openhab” instead of the canonical “openHAB.” Update the wording in
the affected documentation line to match the existing capitalization used
elsewhere on the page and keep the project name consistently styled throughout
the docs.

Source: Learnings


143-143: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider more descriptive link text for accessibility.

The link text "here" on Line 143 is non-descriptive. Screen reader users and those scanning links won't understand the destination. Consider rephrasing to include meaningful text in the link.

This is a minor accessibility improvement that aligns with web content best practices.

-Please find the details [here](https://community.openhab.org/t/wled-control-without-the-binding/101120).
+Please find the [details on the openHAB community forum](https://community.openhab.org/t/wled-control-without-the-binding/101120).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/advanced/home-automation.md` at line 143, The markdown link text in the
home automation docs is too vague and should be replaced with descriptive
wording. Update the sentence containing the existing reference so the link text
clearly describes the destination in context, using the surrounding content in
the advanced/home-automation guide rather than generic text like “here.”

147-147: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Fix "HomeAssistant" to "Home Assistant".

Line 147 writes "HomeAssistant" as one word, but the standard project name is "Home Assistant" (two words). This is a branding inconsistency that should be corrected for professionalism and accuracy.

As per coding guidelines, use consistent, correct capitalization for project names. Based on learnings, ensure programming language names and API datatype names use consistent, correct capitalization.

-- [HomeAssistant and NodeRED flows](https://github.com/Snipercaine/WLED-HomeAssistant)
+- [Home Assistant and NodeRED flows](https://github.com/Snipercaine/WLED-HomeAssistant)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/advanced/home-automation.md` at line 147, Correct the branding in the
home automation documentation by changing the “HomeAssistant” text in the
HomeAssistant and NodeRED flows link to the standard “Home Assistant” spelling.
Update the markdown link label only, and keep the rest of the reference intact;
use the existing link text in the home-automation docs as the target for this
rename.

Source: Learnings

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/advanced/home-automation.md`:
- Line 142: The branding in the home automation docs is inconsistent: the
sentence in the openHAB configuration section uses “Openhab” instead of the
canonical “openHAB.” Update the wording in the affected documentation line to
match the existing capitalization used elsewhere on the page and keep the
project name consistently styled throughout the docs.
- Line 143: The markdown link text in the home automation docs is too vague and
should be replaced with descriptive wording. Update the sentence containing the
existing reference so the link text clearly describes the destination in
context, using the surrounding content in the advanced/home-automation guide
rather than generic text like “here.”
- Line 147: Correct the branding in the home automation documentation by
changing the “HomeAssistant” text in the HomeAssistant and NodeRED flows link to
the standard “Home Assistant” spelling. Update the markdown link label only, and
keep the rest of the reference intact; use the existing link text in the
home-automation docs as the target for this rename.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9e164ea3-94a0-432f-9d69-bccbba0ed371

📥 Commits

Reviewing files that changed from the base of the PR and between 2c85fcc and 659c4f6.

📒 Files selected for processing (1)
  • docs/advanced/home-automation.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant