Update nuki.markdown #38151
Update nuki.markdown #38151
Conversation
Add extra suggestions for direct integration.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe Nuki integration documentation has been updated to enhance the description of controlling Nuki Smart Locks. It now specifies that control can be achieved via both a Nuki Bridge and WiFi-enabled Smart Locks, with an emphasis on cloud connectivity. A new section on local integration alternatives has been introduced, along with sections detailing HomeKit and Matter support. The prerequisites for connecting devices to WiFi and enabling developer mode have been clarified, and the MQTT support section has been updated to include relevant devices. Changes
🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
source/_integrations/nuki.markdown (1)
82-83: Remove Trailing Whitespace in Matter Support SectionStatic analysis detected trailing whitespace on line 83. Please remove any extraneous trailing spaces to adhere to our markdown linting guidelines.
-Smart Lock Ultra, Smart Lock Pro, Smart Lock Go, Smart Locks of 4th Generation support Matter over Thread and can directly integrate with Home Assistant.␣ +Smart Lock Ultra, Smart Lock Pro, Smart Lock Go, Smart Locks of 4th Generation support Matter over Thread and can directly integrate with Home Assistant.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: 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(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nuki.markdown
83-83: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/nuki.markdown
[error] 74-74: Incorrect usage of the term: “Homekit”, use “HomeKit” instead terminology
source/_integrations/nuki.markdown
Outdated
|
|
||
| ## Matter Support | ||
|
|
||
| Smart Lock Ultra, Smart Lock Pro, Smart Lock Go, Smart Locks of 4th Generation support Matter over Thread and can directly integrate with Home Assistant. |
There was a problem hiding this comment.
Instead of sprinkling this document with all kind of references to different ways of integrating; I'd suggest to make a single paragraph that explains it all for all of them.
There was a problem hiding this comment.
I'll update it.
Let me try to figure out how to do this in GitHub.
Apologies if I hit the wrong button somewhere.
There was a problem hiding this comment.
I made some updates. I hope it shows up correctly...
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
- Group alternative integrations - Add references to smart locks with build in wifi - Add links to Nuki knowledge articles and HA integrations
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/nuki.markdown (1)
79-81: 🛠️ Refactor suggestionFix HomeKit Section Heading and Markdown Link Syntax
- The heading on line 79 currently reads “### Homekit support”. It must be updated to “### HomeKit support” to adhere to our documentation standards.
- On line 81, the link for the HomeKit integration is incorrectly formatted by using parentheses instead of markdown link brackets. Please update it to the standard markdown syntax.
-### Homekit support +### HomeKit support-The 2nd and 3rd Generation Smart Locks support [HomeKit via Bluetooth](https://help.nuki.io/hc/en-001/articles/19948907390737-Apple-HomeKit-via-Bluetooth) and can directly integrate with Home Assistant through the (HomeKit integration)(/integrations/homekit_controller/#adding-a-homekit-device-through-bluetooth). +The 2nd and 3rd Generation Smart Locks support [HomeKit via Bluetooth](https://help.nuki.io/hc/en-001/articles/19948907390737-Apple-HomeKit-via-Bluetooth) and can directly integrate with Home Assistant through the [HomeKit integration](/integrations/homekit_controller/#adding-a-homekit-device-through-bluetooth).🧰 Tools
🪛 GitHub Actions: home-assistant.io Test
[error] 79-79: Incorrect usage of the term: “Homekit”, use “HomeKit” instead terminology
🧹 Nitpick comments (5)
source/_integrations/nuki.markdown (5)
22-23: Correct Link Text and Remove Trailing SpacesIn the introduction, the link text “[Buildin WiFi]” should be corrected to “[Built-in WiFi]” for clarity and consistency with the linked resource. Also, please remove the extra trailing spaces on these lines to satisfy markdown linting guidelines.
-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 [Buildin 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) or Nuki Smart Lock with [Built-in WiFi](https://help.nuki.io/hc/en-001/sections/4402761196817-Built-in-Wi-Fi) using the cloud.🧰 Tools
🪛 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)
27-27: Improve Grammar in Prerequisites SectionThe sentence “Turn on the HTTP API and check the details in the screen.” would read more naturally as “check the details on the screen.” Additionally, consider capitalizing “wifi” to “WiFi” for consistency with other parts of the document.
-... Turn on the HTTP API and check the details in the screen. +... Turn on the HTTP API and check the details on the screen.🧰 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)
75-77: Local Integration Alternatives Heading and Trailing Space CleanupThe new heading “## Local integration alternatives” is clear. However, the paragraph on line 77 has a trailing space that should be removed per markdown lint recommendations.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
77-77: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
83-86: Correct MQTT Link FormattingIn the MQTT support section on line 85, the markdown link for MQTT is incorrectly wrapped with an additional pair of square brackets. Please update it to use the standard
[link text](url)format.-[MQTT]([https://support.nuki.io/hc/en-us/articles/12947926779409-MQTT-support]) +[MQTT](https://support.nuki.io/hc/en-us/articles/12947926779409-MQTT-support)
88-90: Address Trailing Space in Matter Support SectionThe “### Matter Support” heading on line 88 has an extra trailing space. Although the content on line 90 is clear, please remove any unnecessary trailing whitespace to comply with markdown standards.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
88-88: 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
🪛 LanguageTool
source/_integrations/nuki.markdown
[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)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nuki.markdown
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)
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)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/nuki.markdown
[error] 79-79: Incorrect usage of the term: “Homekit”, use “HomeKit” instead terminology
Add extra suggestions for direct integration.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit