Restructure Troubleshooting into a hub with per-area pages#814
Merged
Conversation
- Add a Troubleshooting hub (/help/troubleshooting) with icon/chip cards and a "Still stuck?" CTA - Split NetBird Client troubleshooting into an overview + per-OS pages (Linux, Windows, macOS, Android, iOS) - Split Self-hosted troubleshooting into an overview + per-area pages (installation, IdP, dashboard, certificates, connectivity, database) - Split "Report bugs and issues" into Community Support and NetBird Support pages - Add Troubleshooting resource connectivity and a NetBird Cloud pending-approval page - Add DNS troubleshooting Issue 8 (Windows NRPT rule blocked by a lingering GPO) - Cross-reference the new pages from networks, DNS, and reverse-proxy docs; update nav Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Warning Review limit reached
More reviews will be available in 13 minutes and 56 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughThe PR restructures troubleshooting navigation, adds reusable support and troubleshooting components, and introduces new help, client, self-hosted, DNS, connectivity, and relay documentation pages and cross-links. ChangesTroubleshooting docs overhaul
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
- Use "client" instead of "agent" across the client troubleshooting pages (headings, prose, anchors) - Remove unused source: props from the Troubleshooting hub tiles - Relabel the "NetBird Cloud" grouping to "Cloud & identity" (SSO/provisioning also apply to self-hosted) - Add a Tiles title on the report-bug landing; add reverse-proxy -> resource-connectivity cross-link - Fix comma splices introduced by the em-dash cleanup in relayed-connections Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@src/pages/help/community-support.mdx`:
- Around line 12-15: The GitHub Discussions anchor in the links array is
mismatched with the heading slug, so update the entry in the community support
page’s links list to use the same generated ID as the “GitHub Discussions”
heading. Locate the links configuration in the MDX content and change the href
for the GitHub Discussions item to the slugified anchor expected from the
heading text so the sidebar/link jumps correctly.
In `@src/pages/help/troubleshooting-relayed-connections.mdx`:
- Line 48: The troubleshooting link in the relayed connections doc points to a
likely stale fragment on the general client troubleshooting page. Update the
link in troubleshooting-relayed-connections.mdx near the “Start from the general
client troubleshooting page” reference to use the page root or the current
heading slug verified in the client troubleshooting content, so the target is
reliably reachable.
🪄 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
Run ID: 152145fc-98c4-471e-91f7-0969b60083aa
📒 Files selected for processing (31)
src/components/NavigationDocs.jsxsrc/components/StillStuck.jsxsrc/components/SupportBanner.jsxsrc/components/TroubleshootingStart.jsxsrc/components/TroubleshootingTiles.jsxsrc/pages/help/community-support.mdxsrc/pages/help/netbird-support.mdxsrc/pages/help/report-bug-issues.mdxsrc/pages/help/troubleshooting-account-access.mdxsrc/pages/help/troubleshooting-client.mdxsrc/pages/help/troubleshooting-client/android.mdxsrc/pages/help/troubleshooting-client/ios.mdxsrc/pages/help/troubleshooting-client/linux.mdxsrc/pages/help/troubleshooting-client/macos.mdxsrc/pages/help/troubleshooting-client/windows.mdxsrc/pages/help/troubleshooting-relayed-connections.mdxsrc/pages/help/troubleshooting-resource-connectivity.mdxsrc/pages/help/troubleshooting.mdxsrc/pages/manage/dns/troubleshooting.mdxsrc/pages/manage/networks/how-routing-peers-work.mdxsrc/pages/manage/networks/index.mdxsrc/pages/manage/networks/use-cases/reach-services-on-the-routing-peer.mdxsrc/pages/manage/reverse-proxy/troubleshooting.mdxsrc/pages/selfhosted/external-reverse-proxy.mdxsrc/pages/selfhosted/troubleshooting.mdxsrc/pages/selfhosted/troubleshooting/certificates.mdxsrc/pages/selfhosted/troubleshooting/connectivity.mdxsrc/pages/selfhosted/troubleshooting/dashboard.mdxsrc/pages/selfhosted/troubleshooting/database.mdxsrc/pages/selfhosted/troubleshooting/identity-provider.mdxsrc/pages/selfhosted/troubleshooting/installation.mdx
Old deep links like /selfhosted/troubleshooting#debugging-turn-connections now forward to the per-area page, since next.config redirects can't act on the URL fragment. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Thanks for the review — addressed:
Two notes where I diverged:
|
- "open source" (no hyphen), expand NRPT on first use, descriptive alt text + captions on TURN images - Fix inherited "Netbird" casing in the client glossary - Reshape the six self-hosted area pages to Symptom -> likely causes (ordered) -> Fix -> Confirm, preserving anchored headings Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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 `@src/pages/help/community-support.mdx`:
- Line 11: The user-facing description in the community support page should use
the hyphenated “open-source” form for consistency. Update the copy in the
relevant MDX frontmatter/description text associated with community-support so
it reads “open-source self-hosted deployments,” keeping the rest of the wording
unchanged.
In `@src/pages/help/report-bug-issues.mdx`:
- Line 4: Standardize the wording in the help content to use “open-source”
consistently in both descriptions. Update the string in the bug reporting page
and the matching text near the referenced second occurrence so the same
hyphenated form is used everywhere; focus on the copy in report-bug-issues.mdx
and the related description text it contains.
In `@src/pages/help/troubleshooting-client.mdx`:
- Line 512: The glossary entry contains a typo in the troubleshooting-client
content: the term “nunning” should be corrected to “running”. Update the text in
the `troubleshooting-client.mdx` glossary item for `int-dns2` so the description
reads naturally and matches the intended wording.
- Line 740: Fix the possessive typo in the routing-table sentence by changing
the wording in the troubleshooting content from “it’s custom routes” to “its
custom routes.” Update the sentence in the MDX documentation where the NetBird
client routing table is described so the possessive form is correct and
consistent with the surrounding text.
In `@src/pages/selfhosted/troubleshooting.mdx`:
- Line 88: Update the support-routing sentence in troubleshooting.mdx to use the
consistent “Open-source self-hosted” wording instead of “Open source
self-hosted”; make this text-only doc copy change in the support links section
and keep the rest of the sentence structure unchanged.
🪄 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
Run ID: b8212108-a023-4a25-acf0-bbe27ad4a43c
📒 Files selected for processing (14)
src/components/HashRedirect.jsxsrc/pages/help/community-support.mdxsrc/pages/help/netbird-support.mdxsrc/pages/help/report-bug-issues.mdxsrc/pages/help/troubleshooting-client.mdxsrc/pages/help/troubleshooting-client/windows.mdxsrc/pages/manage/dns/troubleshooting.mdxsrc/pages/selfhosted/troubleshooting.mdxsrc/pages/selfhosted/troubleshooting/certificates.mdxsrc/pages/selfhosted/troubleshooting/connectivity.mdxsrc/pages/selfhosted/troubleshooting/dashboard.mdxsrc/pages/selfhosted/troubleshooting/database.mdxsrc/pages/selfhosted/troubleshooting/identity-provider.mdxsrc/pages/selfhosted/troubleshooting/installation.mdx
✅ Files skipped from review due to trivial changes (3)
- src/pages/selfhosted/troubleshooting/certificates.mdx
- src/pages/selfhosted/troubleshooting/dashboard.mdx
- src/pages/help/troubleshooting-client/windows.mdx
🚧 Files skipped from review as they are similar to previous changes (5)
- src/pages/selfhosted/troubleshooting/database.mdx
- src/pages/manage/dns/troubleshooting.mdx
- src/pages/selfhosted/troubleshooting/connectivity.mdx
- src/pages/selfhosted/troubleshooting/identity-provider.mdx
- src/pages/help/netbird-support.mdx
- "nunning" -> "running" in the glossary - possessive "it's" -> "its" in the routing-table sentence Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Thanks @coderabbitai — went through all seven: Fixed (
Not applied, with reasons:
|
Contributor
|
Tip For best results, initiate chat on the files or code changes.
Thanks for the careful pass-through.
I’m happy to drop those two earlier suggestions. ✏️ Learnings added
|
- database: point the "upgrade path" link at /selfhosted/maintenance/upgrade; selfhosted-quickstart has no #upgrade anchor so the old link landed at page top - client: add HashRedirect so old #net-bird-agent-status deep links forward to the renamed #net-bird-client-status section on the same page
- self-hosted troubleshooting: extend the HashRedirect map with the per-issue (###-level) anchors from the old single page, so old deep links land on the exact sub-section of the new area page rather than just the page top - client glossary: lowercase "NetBird client" in the peer-a/peer-b entries (house convention) and fix "linux" -> "Linux"
- connectivity: fix bad CSS class imagewrapper-nig -> imagewrapper on the TURN-test screenshot (the typo'd class matched no style and broke zoom) - gloss acronyms on first use: GPO (DNS Issue 8), IdP/SSO (identity-provider), ACME (certificates), CORS (dashboard)
SunsetDrifter
approved these changes
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructures the Troubleshooting docs from a few long pages into a hub with focused, per-area pages.
What changed
/help/troubleshooting): icon/chip cards to find your issue by area, and a "Still stuck?" CTA (Community / NetBird Support).Validated with
npm run build.Screenshots
Overall look — Troubleshooting hub
NetBird Client (overview + per-OS)
Self-hosted (overview + per-area)
Report a bug → Community / NetBird Support
New content
🤖 Generated with Claude Code
Summary by CodeRabbit