Update add-on docs to match updated Tailscale docs #416
Conversation
WalkthroughThe documentation for the Tailscale Home Assistant Community Add-on has been revised to improve clarity and usability. Key updates include rephrased instructions, enhanced explanations for Changes
Possibly related PRs
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
🧹 Outside diff range and nitpick comments (4)
tailscale/DOCS.md (4)
Line range hint
32-32: Approved: Helpful note about browser compatibility added.The addition of the note about browser compatibility during the authentication step is valuable for users. It helps prevent potential frustration and provides a clear recommendation.
Consider specifying why some browsers might not work to give users more context. For example:
- **Note:** Some browsers don't work with this step. It is recommended to + **Note:** Some browsers may have issues with the authentication process due to security settings. It is recommended to🧰 Tools
🪛 LanguageTool
[uncategorized] ~282-~282: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tworking][tailscale_info_site_to_site] (eg. to traverse multiple networks), you can...(E_G)
284-285: Approved: Improved guidance for advanced site-to-site networking.The updated instructions provide clearer guidance for users implementing advanced site-to-site networking configurations. This change aligns well with the PR objective of updating the add-on docs to match the Tailscale documentation.
Consider adding a brief explanation of why a user might need to disable this functionality. For example:
steps from step 3 on [Site-to-site networking][tailscale_info_site_to_site]. But -do it only when you really understand why you need this. +do it only when you really understand why you need this, such as when you require more complex routing scenarios or need to overcome subnet conflicts.
326-327: Approved: Clearer instructions for accessing tailnet clients from local subnet.The updated instructions provide a more specific reference to the steps required for accessing other clients on the tailnet from the local subnet. This change improves the clarity of the documentation and aligns with the PR objective.
To further improve clarity, consider rephrasing slightly:
-follow steps from step 3 on [Site-to-site -networking][tailscale_info_site_to_site]. +follow the instructions starting from step 3 in the [Site-to-site +networking][tailscale_info_site_to_site] guide.
Line range hint
426-426: Approved: New link added for Tailscale app connectors.The addition of the link for Tailscale app connectors is helpful and supports the new
advertise_connectoroption mentioned earlier in the document.For consistency with other Tailscale-related links, consider renaming the link:
-[tailscale_info_app_connectors]: https://tailscale.com/kb/1281/app-connectors +[tailscale_info_app_connectors]: https://tailscale.com/kb/1281/app-connectors/Note the added trailing slash.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~282-~282: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tworking][tailscale_info_site_to_site] (eg. to traverse multiple networks), you can...(E_G)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- tailscale/DOCS.md (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
tailscale/DOCS.md (2)
Line range hint
399-399: Approved: Copyright year updated.The copyright year has been correctly updated to 2024.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~282-~282: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tworking][tailscale_info_site_to_site] (eg. to traverse multiple networks), you can...(E_G)
Line range hint
1-431: Overall: Documentation updates improve clarity and align with Tailscale changes.The changes made to the Tailscale add-on documentation successfully address the PR objective of updating the docs to match the updated Tailscale site-to-site networking documentation. Key improvements include:
- Added note about browser compatibility during authentication.
- Updated instructions for advanced site-to-site networking configurations.
- Clearer guidance on accessing tailnet clients from the local subnet.
- Updated copyright year.
- Added reference for the new app connectors feature.
These updates enhance the overall quality and accuracy of the documentation, providing users with more precise instructions and references to the latest Tailscale features.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~282-~282: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tworking][tailscale_info_site_to_site] (eg. to traverse multiple networks), you can...(E_G)
Proposed Changes
TS siteto-site networking docs changed, this updates the reference to the steps in it.
Related Issues
related #415
Summary by CodeRabbit
snat_subnet_routesfor advanced site-to-site networking.userspace_networkingfor better understanding of client access on the tailnet.