Z-Wave terminology: change controller to adapter #39805
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines Z-Wave terminology by replacing references to the hardware “controller” with “adapter” and updating the terminology mapping table.
- Updated all hardware references from “controller” to “adapter” in setup, troubleshooting, and FAQ sections.
- Reordered and added entries in the terminology mapping table to include “controller” vs. “adapter” distinction.
- Adjusted instructions, notes, and action descriptors to use “adapter” consistently.
Comments suppressed due to low confidence (2)
source/_integrations/zwave_js.markdown:65
- The definition column is empty for “barrier operator.” Please provide a brief description of what a barrier operator represents in Z-Wave terminology.
| barrier operator | cover | |
source/_integrations/zwave_js.markdown:66
- The definition column is empty for “controller.” Please add a concise description of its network role. Additionally, fix the grammar to read “when referring to the network role.”
| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring the network role (such as primary, secondary controller) | |
📝 Walkthrough""" WalkthroughThe documentation for the Z-Wave JS integration was updated to standardize the terminology, replacing all references to "controller," "dongle," and "stick" (when referring to hardware) with "adapter." This change was applied consistently across setup, troubleshooting, migration, backup, firmware updates, and event descriptions. No technical procedures or code were altered. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation terminology updates without affecting control flow or feature logic. 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: 1
🧹 Nitpick comments (3)
source/_integrations/zwave_js.markdown (3)
53-54: Clarify wording and remove redundancyThe second sentence is hard to parse (“can be operated with any Z-Wave network with other …”) and repeats “Z-Wave”/“network” unnecessarily.
-You do not need a Z-Wave adapter that is specifically designed for the Z-Wave integration in Home Assistant. The Z-Wave integration in Home Assistant can be operated with any Z-Wave network with other Z-Wave certified devices from other manufacturers. +You don’t need a special “Home-Assistant-only” Z-Wave adapter. Home Assistant works with any standards-compliant Z-Wave adapter and with Z-Wave-certified devices from any manufacturer.
64-66: Missing preposition in terminology mapping“when referring the network role” → “when referring to the network role” (and trim double space before trailing pipe).
-| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring the network role (such as primary, secondary controller) | | +| controller | adapter, when referring to the hardware device that provides Z-Wave functionality. The term “controller” is still used when referring to the network role (for example, primary or secondary controller). | |
120-126: Fix ordered-list numbering (markdownlint MD029)
markdownlintflags this section because the list jumps from 4 → 5 → 6 after the nested bullets.
Simplest fix: use automatic numbering (1.) or renumber explicitly.-3. Wait for the installation to complete. -4. Depending on your Home Assistant version, you may be prompted for network security keys. +1. Wait for the installation to complete. +1. Depending on your Home Assistant version, you may be prompted for network security keys. … -5. Wait for the Z-Wave JS add-on to start up. -6. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown. +1. Wait for the Z-Wave JS add-on to start up. +1. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown.
📜 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/zwave_js.markdown(26 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
1109-1109: Link fragments should be valid
(MD051, link-fragments)
1111-1111: Link fragments should be valid
(MD051, link-fragments)
⏰ 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/zwave_js.markdown (1)
85-86: Verify updated link slugThe anchor still points to
/docs/z-wave/controllers/…, but the surrounding text now uses “adapter(s)”.
Please check that the destination slug hasn’t been renamed accordingly; otherwise this will become a dead link.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
1109-1111: Broken internal anchor#adapteris still unresolvedThis was flagged in the previous review and the link fragment remains invalid (
### Resetting a Z-Wave adapterrenders as#resetting-a-z-wave-adapter).- after a [factory reset](#adapter) + after a [factory reset](#resetting-a-z-wave-adapter) - Home Assistant [resets the Z-Wave adapter](#adapter). + Home Assistant [resets the Z-Wave adapter](#resetting-a-z-wave-adapter).
🧹 Nitpick comments (1)
source/_integrations/zwave_js.markdown (1)
119-126: Ordered-list numbering breaks after the collapsible “Manual setup steps” block
markdownlint(MD029) reports the sequence restarting at “5.” and “6.” where it expects “3.” and “4.”.
Renumber to keep the list valid (or switch to1.on every line).-3. Wait for the installation to complete. -4. Depending on your Home Assistant version, you may be prompted for network security keys. +1. Wait for the installation to complete. +2. Depending on your Home Assistant version, you may be prompted for network security keys. -5. Wait for the Z-Wave JS add-on to start up. -6. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown. +3. Wait for the Z-Wave JS add-on to start up. +4. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown.
📜 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/zwave_js.markdown(26 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
1109-1109: Link fragments should be valid
(MD051, link-fragments)
1111-1111: Link fragments should be valid
(MD051, link-fragments)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
1109-1111: Broken internal anchors – still unresolved
The heading renders as### Resetting a Z-Wave adapter, giving the fragment#resetting-a-z-wave-adapter, not#adapter.-[factory reset](#adapter) +[factory reset](#resetting-a-z-wave-adapter) -[resets the Z-Wave adapter](#adapter) +[resets the Z-Wave adapter](#resetting-a-z-wave-adapter)
🧹 Nitpick comments (2)
source/_integrations/zwave_js.markdown (2)
63-67: Fix wording in terminology tableMissing preposition breaks the sentence flow.
-| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring the network role (such as primary, secondary controller) | | +| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term **controller** is still used when referring **to** the network role (such as primary or secondary controller). | |
99-104: List numbering trips markdown-lintThe blank line before the nested bullet restarts the ordered list, so items
5./6.are reported as the 3rd/4th items (MD029).
Easiest fix: use the GitHub-style1.prefix for every list item inside the main sequence:-5. Wait for the installation to complete. -6. Once the installation is complete, the **Device info** ... +1. Wait for the installation to complete. +1. Once the installation is complete, the **Device info** ...
📜 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/zwave_js.markdown(23 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
1109-1109: Link fragments should be valid
(MD051, link-fragments)
1111-1111: Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (2)
source/_integrations/zwave_js.markdown (2)
85-85: Verify legacy “controllers” URLThe link still points to
/docs/z-wave/controllers/….
If that page was (or will be) renamed to “…/adapters/…”, this link will 404 after the rename.
Confirm whether the old URL will be kept as an alias; otherwise update the path now.
897-899: Second instance of legacy “controllers” URLSame concern as above – please validate that
/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-moduleswill stay valid after the terminology switch. Update if necessary.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
1117-1120: Broken internal anchors (#adapter) – still unresolved
The two links here resolve to#adapter, which doesn’t exist. Replace with#resetting-a-z-wave-adapter(heading slug):-[factory reset](#adapter) +[factory reset](#resetting-a-z-wave-adapter) -[resets the Z-Wave adapter](#adapter) +[resets the Z-Wave adapter](#resetting-a-z-wave-adapter)
🧹 Nitpick comments (2)
source/_integrations/zwave_js.markdown (2)
53-54: Sentence reads awkwardly; tighten wording for clarityThe current wording is verbose and slightly confusing. Consider slimming it down and rearranging the clauses:
-You do not need a Z-Wave adapter that is specifically designed for the Z-Wave integration in Home Assistant. The Z-Wave integration in Home Assistant can be operated with any Z-Wave network with other Z-Wave certified devices from other manufacturers. All mains operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network. +You don’t need a Home-Assistant-specific Z-Wave adapter. +The integration works in any Z-Wave network alongside certified devices from any manufacturer. +All mains-powered nodes act as repeaters, regardless of vendor, improving network reliability.
63-66: Missing “to” in the table definitionSmall grammatical glitch in the controller → adapter mapping row.
-| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring the network role (such as primary, secondary controller) | | +| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring to the network role (such as primary or secondary controller). | |
📜 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/zwave_js.markdown(25 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
1117-1117: Link fragments should be valid
(MD051, link-fragments)
1119-1119: Link fragments should be valid
(MD051, link-fragments)
⏰ 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/zwave_js.markdown (1)
85-85: Link slug still points at “controllers” – verify final URL before merge
/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modulesstill contains “controllers” even though the docs have been re-termed to “adapters”.
Double-check whether the target page will be renamed; if so, update the slug (and any redirects) to avoid dead links.
|
Shouldn't this PR target current branch now since yesterday's release included the string changes for controller? |
💯 I'm working on it, that's why I put it in Draft mode. trying to resolve merge conflicts 😅 🫠 |
streamline terms - stick - USB stick - dongle
Co-authored-by: AlCalzone <dominic.griesel@nabucasa.com>
Co-authored-by: AlCalzone <dominic.griesel@nabucasa.com>
db0dfb6 to
63ce7fd
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
119-126: Ordered-list numbering still breaks MD029The list continues after a
<details>block. Markdown-lint expects either auto-numbering (1.everywhere) or a fresh1.after the block.
Current3.…6.triggers MD029 errors and will fail CI.-3. Wait for the installation to complete. -4. Depending on your Home Assistant version, you may be prompted for network security keys. +1. Wait for the installation to complete. +2. Depending on your Home Assistant version, you may be prompted for network security keys. … -5. Wait for the Z-Wave JS add-on to start up. -6. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown. +3. Wait for the Z-Wave JS add-on to start up. +4. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown.
🧹 Nitpick comments (2)
source/_integrations/zwave_js.markdown (2)
63-70: Missing preposition in controller‐to‐adapter note“…is still used when referring the network role” → should read “referring to the network role”.
-| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring the network role (such as primary, secondary controller) | | +| controller | adapter, when referring to the hardware device that provides the Z-Wave functionality. The term controller is still used when referring **to** the network role (such as primary, secondary controller) | |
295-297: Superfluous blank line violates MD012Two consecutive blank lines render fine but trigger the linter. Remove one.
- - 
📜 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/zwave_js.markdown(23 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
295-295: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
🔇 Additional comments (2)
source/_integrations/zwave_js.markdown (2)
1-1209: No broken#adapteranchors detected
Ran a recursive grep for(#adapter)and found no occurrences insource/_integrations/zwave_js.markdown. No further changes required.
85-86: No update needed—“controllers” slug is correct
The filesource/_docs/z-wave/controllers.markdownstill exists, so the link/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modulesis valid. There is noadapterspage to link to.– No action required on
source/_integrations/zwave_js.markdown
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/zwave_js.markdown (1)
119-126: Fix ordered-list numbering (markdown-lint MD029).The list that resumes after the
<details>block is treated as a brand-new list by Markdown, so numbering must restart from1.(or just use1.for every item).
Current numbering (3.…6.) breaks the CI linter.-3. Wait for the installation to complete. -4. Depending on your Home Assistant version, you may be prompted for network security keys. +1. Wait for the installation to complete. +2. Depending on your Home Assistant version, you may be prompted for network security keys. … -5. Wait for the Z-Wave JS add-on to start up. -6. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown. +3. Wait for the Z-Wave JS add-on to start up. +4. Once the installation is complete, the **Device info** of the Z-Wave adapter is shown.
🧹 Nitpick comments (1)
source/_integrations/zwave_js.markdown (1)
293-296: Remove superfluous blank line (markdown-lint MD012).There are two consecutive blank lines after the screenshot reference, triggering MD012. Delete one of them.
- -
📜 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/zwave_js.markdown(23 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/zwave_js.markdown
124-124: Ordered list item prefix
Expected: 3; Actual: 5; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 4; Actual: 6; Style: 1/2/3
(MD029, ol-prefix)
295-295: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ 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/zwave_js.markdown (1)
1-1208: No remaining(#adapter)anchor fragments detected.
Ran a repository-wide search for(#adapter)in Markdown files and found zero occurrences. There are no broken internal links to update.
|
Thank you for the review, @AlCalzone and @MartinHjelmare |
depends on frontend and core UI strings. Don't merge yet.
streamline terms
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit