Update documentation about UI bug in configuration editor #463
Conversation
|
Warning Rate limit exceeded@lmagyar has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 52 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request updates the Tailscale add-on documentation for Home Assistant by adding three distinct cautionary notes. These notes advise users to avoid using the "Show unused optional configuration options" switch, require manual updates to the YAML configuration for optional parameters, and warn that the Home Assistant UI may misrepresent the state of certain options. No changes were made to any exported or public entities. Changes
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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: 0
🧹 Nitpick comments (3)
tailscale/DOCS.md (3)
86-89: Caution Block on UI Default Option Warning
This block clearly warns users not to use the "Show unused optional configuration options" switch, which is essential given the UI limitations. Please verify that no unintended blank lines or extra spaces exist within the block, as markdownlint flagged potential issues.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
89-89: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
90-95: Simplify Wording for Optional Configuration Change
Consider rewording line 91 to improve clarity—replacing "change the default behaviour of any of these optional configuration options" with "change the default behaviour of these optional configuration options" makes the message more concise. Also, double-check that the blockquote does not include any extra blank lines that could trigger markdownlint's MD028 warning.🧰 Tools
🪛 LanguageTool
[style] ~91-~91: Consider simply using “of” instead.
Context: ...ou want to change the default behaviour of any of these optional > configuration options,...(OF_ANY_OF)
🪛 markdownlint-cli2 (0.17.2)
95-95: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
96-104: Refine Warning Block for UI Misrepresentation
The warning block effectively informs users about potential misrepresentation of option states in the Home Assistant UI. For enhanced readability, consider breaking up long sentences or simplifying the language. Additionally, ensure the blockquote format is consistent (i.e., no extra blank lines within the quoted text) to address markdownlint suggestions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tailscale/DOCS.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
tailscale/DOCS.md
[style] ~91-~91: Consider simply using “of” instead.
Context: ...ou want to change the default behaviour of any of these optional > configuration options,...
(OF_ANY_OF)
🪛 markdownlint-cli2 (0.17.2)
tailscale/DOCS.md
89-89: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
95-95: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
Proposed Changes
This issue is much more serious than it seems, users always show configurations where most of the default enabled options are enabled manually, and complain that disabled options are not working or hard to make them to work.
They waste hours on forums and debugging a configuration issue caused by a very misleading UI config editor!
Related Issues
fixes #462
Summary by CodeRabbit