Reformat docs about read-only Web-UI

[lmagyar]

Proposed Changes

Just follows the formatting style of #463

Related Issues

Summary by CodeRabbit

• Documentation
  • Updated the add-on documentation to clearly explain that certain configuration options available via the web interface are read-only, with changes not persisting after a restart.
  • Reorganized and reformatted the advisory note for improved clarity and user awareness of these limitations.

[coderabbitai]

Walkthrough

The Tailscale add-on documentation has been updated to improve clarity regarding configuration options available via the web interface. A highlighted block note has been added to explain that these options are read-only on the web UI and that any changes will be lost on add-on restart. Additionally, the earlier note has been removed from its previous location to reduce confusion. The overall documentation structure remains unchanged.

Changes

File	Change Summary
tailscale/DOCS.md	Added a block note clarifying that configuration options on the web interface are read-only (changes reset on restart). Removed the old note.

Suggested labels

documentation

Suggested reviewers

• frenck

Poem

I'm a bunny in the docs, hopping with delight,
Updating notes to keep the facts in sight.
With clear words and a format so neat,
The web UI hints now sound complete.
Hoppy code and docs, a joyful rabbit treat!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

tailscale/DOCS.md (1)

81-86: Refine Note Block Formatting for Clarity and Consistency

The updated note block clearly fulfills the PR’s objective by emphasizing that configuration options available via the Web UI are read-only. I recommend a couple of minor stylistic improvements for better readability and consistency:

• Hyphenate "read-only": Replace “read only” with “read-only” to match standard terminology.
• Streamline the causal clause: Remove the comma before “because” (in line 84) to ensure a smoother, more direct explanation.

For example, you could update the note block to:

🧰 Tools

🪛 LanguageTool

[formatting] ~84-~84: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...u can't > change them through the Web UI, because all the changes made there would be > l...

(COMMA_BEFORE_BECAUSE)

---

[typographical] ~84-~84: Consider adding a comma.
Context: ...the Web UI, because all the changes made there would be > lost when the add-on is rest...

(IF_THERE_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b0fc8aa and 4e6c566.

📒 Files selected for processing (1)

• tailscale/DOCS.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

tailscale/DOCS.md

[formatting] ~84-~84: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...u can't > change them through the Web UI, because all the changes made there would be > l...

(COMMA_BEFORE_BECAUSE)

---

[typographical] ~84-~84: Consider adding a comma.
Context: ...the Web UI, because all the changes made there would be > lost when the add-on is rest...

(IF_THERE_COMMA)

[frenck]

Thanks, @lmagyar 👍

../Frenck