Z-Wave: update steps to enable debug logging #39790
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 updates the steps for enabling and disabling debug logging in the Z-Wave JS integration to match the current UI and adds a new step for changing the log level.
- Replaced the old left-hand menu instruction with the three-dot menu and bolded UI strings
- Added Result sub-items under enable/disable steps for clarity
- Introduced a new step for changing the log level via the cogwheel and Logs tab
Comments suppressed due to low confidence (3)
source/_integrations/zwave_js.markdown:1071
- [nitpick] Consider rephrasing to avoid repeating “select”: for example, “open the three-dot {% icon “mdi:dots-vertical” %} menu and choose Enable debug logging.”
2. In the top-right corner, select the three-dot {% icon "mdi:dots-vertical" %} menu and select **Enable debug logging**.
source/_integrations/zwave_js.markdown:1072
- The nested list item is indented by three spaces; for proper Markdown nesting, use four spaces for the sub-item.
- **Result**: The log level will be set to `debug` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs.
source/_integrations/zwave_js.markdown:1073
- [nitpick] The colon after “panel” reads awkwardly. Consider moving the badge into the sentence—e.g., “on the Z-Wave integration panel {% my integration badge domain="zwave_js" %}, select the cogwheel icon.”
3. If you want to change the log level, on the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}, select the cogwheel {% icon "mdi:cog-outline" %}.
📝 WalkthroughWalkthroughThe documentation for the Z-Wave integration in Home Assistant was updated for clarity and consistency in describing UI elements. Terminology for menu icons was standardized, instructions for accessing debug logging were clarified, and new steps for changing log levels via the cogwheel icon and Logs tab were added. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistantUI
participant ZWaveIntegration
User->>HomeAssistantUI: Open Z-Wave Integration Panel
User->>HomeAssistantUI: Click three-dot menu (top-right)
User->>HomeAssistantUI: Select "Enable/Disable Debug Logging"
HomeAssistantUI->>ZWaveIntegration: Update debug logging setting
User->>HomeAssistantUI: Click cogwheel icon
User->>HomeAssistantUI: Select "Logs" tab
User->>HomeAssistantUI: Change log level
HomeAssistantUI->>ZWaveIntegration: Apply new log level
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 (4)
source/_integrations/zwave_js.markdown (4)
281-282: Use consistent wording for the overflow-menu iconElsewhere in the docs we standardize on “three-dot menu” (singular) but here we use “three-dot” followed immediately by the icon macro. Consider rewriting for uniformity and readability, e.g.:
-Under **Device info**, select the three-dot {% icon "mdi:dots-vertical" %} menu, then select **Factory reset**. +Under **Device info**, open the three-dot {% icon "mdi:dots-vertical" %} menu and select **Factory reset**.Minor, but consistency helps users scan long pages quickly.
1057-1059: Avoid repeating “select” twice in the same sentenceThe current wording is slightly awkward (“Then, select the three-dot menu”). A lighter phrasing:
-2. Select the **Z-Wave** integration. Then, select the three-dot {% icon "mdi:dots-vertical" %} menu. +2. Select the **Z-Wave** integration and open the three-dot {% icon "mdi:dots-vertical" %} menu.Maintains imperative mood while removing redundancy.
1070-1075: Clarify step sequence & UI element names
- The list jumps from the three-dot menu to the cogwheel without an explicit “back” action; readers might think both icons are in the same panel.
- “Select the log level” is ambiguous—consider “choose a log level from the drop-down”.
Proposed tweak:
-3. If you want to change the log level, on the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}, select the cogwheel {% icon "mdi:cog-outline" %}. - - Select the **Logs** tab, then select the log level. +3. To adjust the log level later, open the Z-Wave integration panel {% my integration badge domain="zwave_js" %}, click the cogwheel {% icon "mdi:cog-outline" %}, switch to the **Logs** tab, and choose the desired log level from the drop-down.Adds context and removes potential ambiguity.
1079-1081: Mirror enable/disable phrasing for symmetryThe disable section currently differs from the enable section (“select the three-dot menu and select Disable debug logging”). Matching phrasing improves scan-ability:
-2. In the top-right corner, select the three-dot {% icon "mdi:dots-vertical" %} menu and select **Disable debug logging**. +2. In the top-right corner, open the three-dot {% icon "mdi:dots-vertical" %} menu and choose **Disable debug logging**.Keeps both instructions parallel.
📜 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(3 hunks)
|
Thanks! |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit