Rename Nuki to Nuki Bridge #38676
Rename Nuki to Nuki Bridge #38676
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Nuki integration was revised to focus specifically on the "Nuki Bridge" rather than the broader category of Nuki smart lock devices. The introductory section was updated to remove references to WiFi-enabled Nuki smart locks and cloud-based control, now specifying control exclusively via the Nuki Bridge. No changes were made to the technical details or other sections of the document. 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:
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 (1)
source/_integrations/nuki.markdown (1)
22-22: Clarify integration name and remove trailing spaces
The introduction still reads “The Nuki integration…” but the integration has been renamed. Change this to “The Nuki Bridge integration…” and remove the trailing space at the end of the line to satisfy markdownlint.Proposed diff:
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nuki.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nuki.markdown
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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
📝 WalkthroughWalkthroughThe documentation for the Nuki integration was updated to clarify that it specifically pertains to controlling Nuki Smart Locks via the Nuki Bridge. References to controlling locks with built-in WiFi through the cloud were removed, and the title and introductory sentence were revised for greater specificity. No changes were made to the technical content, configuration, or functionality described in the document. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation wording and do not affect control flow or feature implementation. 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:
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
🔭 Outside diff range comments (1)
source/_integrations/nuki.markdown (1)
1-91: 💡 Verification agent🧩 Analysis chain
Verify no remaining “Nuki integration” references
To ensure all internal links and mentions across the docs have been updated to “Nuki Bridge,” run:This will help catch any missed occurrences in the markdown.
🏁 Script executed:
#!/bin/bash # Verify no lingering references to "Nuki integration" rg -n "Nuki integration" source/_integrationsLength of output: 262
Replace remaining “Nuki integration” reference with “Nuki Bridge”
There’s still one occurrence that needs updating:• File source/_integrations/nuki.markdown, line 22
- The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge). + The Nuki Bridge allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge).🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...n on the HTTP API and check the details in the screen. Please note that the API to...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[typographical] ~27-~27: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...lease note that the API token should be 6-20 characters long, even though the app al...(HYPHEN_TO_EN)
[style] ~40-~40: In American English, abbreviations like “etc.” require a period.
Context: ...ce issues with the API (authentication, etc). The default isTrue. {% endconfigur...(ETC_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
23-23: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
52-52: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
53-53: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
61-61: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
62-62: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
72-72: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
73-73: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
77-77: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
88-88: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
🧹 Nitpick comments (3)
source/_integrations/nuki.markdown (3)
2-2: Title capitalization consistency
The title uses “Nuki bridge” with a lowercase “b.” For consistency with branding and other integration titles, capitalize “Bridge”: use- title: Nuki bridge + title: Nuki Bridge
3-3: Refine description for clarity and consistency
The description line still refers to “a Nuki bridge” and uses “their.” Consider updating to use “Nuki Bridge” (capital B) and “your” to improve readability:- description: Instructions on how to integrate a Nuki bridge to control their Smart Lock devices. + description: Instructions on how to integrate a Nuki Bridge to control your Smart Lock devices.
22-22: Update introductory sentence and remove trailing whitespace
The sentence still reads “The Nuki integration” and has trailing spaces at the end. Align with the PR objectives and remove extra spaces:- The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge). + The Nuki Bridge integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nuki.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nuki.markdown
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
|
Whats the motivation for this change? I think we could add an option for different connection modes inside one integration. I dont know what is preferred. |
Nuki has multiple integrations and will be added as a brand too with their Matter products. Meaning this will become problematic for a user to pick the right integration if this one is just called "Nuki".
That won't work for IoT standards like Matter. |
|
Thanks for the clarification @frenck |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/nuki.markdown (1)
2-3: Frontmatter naming updated correctly
The title and description fields now consistently use “Nuki Bridge”, aligning with Home Assistant naming conventions. One optional grammar nitpick: consider replacing “their” with “its” to refer to the Bridge singularly in the description.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nuki.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nuki.markdown
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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
| @@ -19,7 +19,7 @@ ha_dhcp: true | |||
| ha_integration_type: integration | |||
| --- | |||
|
|
|||
| The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge) or Nuki Smart Lock with [Build-in WiFi](https://help.nuki.io/hc/en-001/sections/4402761196817-Built-in-Wi-Fi) using the cloud. | |||
| The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge](https://help.nuki.io/hc/en-001/sections/360004474718-Bridge). | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify integration name and remove trailing whitespace
Update the sentence to reference “Nuki Bridge integration” for clarity and trim the trailing space at the end.
-The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge].
+The Nuki Bridge integration allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via a [Nuki Bridge].Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit