Skip to content

Update documentation links and extend error messages - #708

Open
lmagyar wants to merge 5 commits into
hassio-addons:mainfrom
lmagyar:pr-update-serve-funnel-links-messages
Open

Update documentation links and extend error messages#708
lmagyar wants to merge 5 commits into
hassio-addons:mainfrom
lmagyar:pr-update-serve-funnel-links-messages

Conversation

@lmagyar

@lmagyar lmagyar commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Proposed Changes

Better link to TS docs, better error messages for users who don't read docs.

Related Issues

Summary by CodeRabbit

  • Documentation
    • Updated account setup and admin-console URL references across the guide.
    • Refreshed the “share_homeassistant” Funnel step to reference the correct requirement and updated its related link.
  • Bug Fixes
    • Improved Home Assistant sharing failure messages with clearer, multi-line guidance when HTTPS or Funnel support is disabled.
    • Enhanced the exit-node vs. advertise-exit-node conflict message to provide clearer instructions.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f03e47bc-90c8-4a86-b2a1-fa6e988a5359

📥 Commits

Reviewing files that changed from the base of the PR and between 2ea735c and ea0d1db.

📒 Files selected for processing (1)
  • tailscale/DOCS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • tailscale/DOCS.md

Walkthrough

Updated Tailscale console URLs, Funnel documentation references, and runtime error messages for Home Assistant sharing and conflicting exit-node configuration.

Changes

Tailscale guidance and runtime errors

Layer / File(s) Summary
Console and Funnel documentation
tailscale/DOCS.md
Account, admin-console, machines, and Funnel references now use updated Tailscale URLs and terminology.
Share Home Assistant runtime messages
tailscale/rootfs/etc/s6-overlay/s6-rc.d/share-homeassistant/run
Disabled HTTPS and Funnel errors now use multi-line messages with share_homeassistant documentation guidance.
Exit-node error message
tailscale/rootfs/etc/s6-overlay/s6-rc.d/post-tailscaled/run
The conflicting exit-node configuration error now includes additional configuration guidance.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Poem

A rabbit reviews each console trail 🐇
While clearer error messages prevail
Funnel links hop to a newer place
Exit-node notes explain the case
The docs and scripts now share one pace

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: documentation link updates and clearer error messages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lmagyar lmagyar added documentation Solely about the documentation of the project. no-stale This issue or PR is exempted from the stable bot. labels Jun 26, 2026
@lmagyar lmagyar changed the title Update serve and funnel related documentation links and error messages Update documentation links and extend error messages Jun 26, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tailscale/DOCS.md`:
- Line 18: Update the prerequisite link in DOCS.md from the Tailscale admin
console URL to https://tailscale.com/start so it points to the signup flow
described in the documentation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 96c99edd-9d88-49ab-914d-0369aa4bf993

📥 Commits

Reviewing files that changed from the base of the PR and between 221c8c7 and 2ea735c.

📒 Files selected for processing (1)
  • tailscale/DOCS.md

Comment thread tailscale/DOCS.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Solely about the documentation of the project. no-stale This issue or PR is exempted from the stable bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant