Skip to content

docs: add NetBird to showcase#5770

Open
heisbrot wants to merge 2 commits into
wailsapp:masterfrom
heisbrot:netbird-showcase
Open

docs: add NetBird to showcase#5770
heisbrot wants to merge 2 commits into
wailsapp:masterfrom
heisbrot:netbird-showcase

Conversation

@heisbrot

@heisbrot heisbrot commented Jul 10, 2026

Copy link
Copy Markdown

Description

Adds NetBird to the community showcase. NetBird's desktop app was recently rebuilt from scratch with Wails, so this adds it as a showcase example.

  • New showcase page docs/src/content/docs/community/showcase/netbird.md with three screenshots (peers/resources view, profiles, settings), a short description, and links to the announcement blog post and source code.
  • Three WebP screenshots added under docs/src/assets/showcase-images/.
  • Added NetBird to the list in index.mdx (list reordered alphabetically).

No linked issue — showcase additions don't require one.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Built and served the docs site locally (npm run dev in docs/). Verified both the showcase overview page and the new NetBird page render correctly with all images.

  • Windows
  • macOS
  • Linux

Test Configuration

Docs-only change; wails doctor is not applicable. Tested on macOS with the Astro/Starlight docs dev server.

Checklist:

  • (v2 only) I have updated website/src/pages/changelog.mdx with details of this PR (v3 changelog entries are added automatically)
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Added a new NetBird community showcase page covering private networking and centralized access control.
    • Included refreshed screenshots of the Peers, Profiles, and Settings views.
    • Updated the community showcase directory to add NetBird and improve ordering of existing entries.
    • Added outbound links to the NetBird blog post and the desktop client UI repository.

@github-actions github-actions Bot added the Documentation Improvements or additions to documentation label Jul 10, 2026
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Adds a NetBird showcase page with three screenshots, registers it in the community showcase listing, and reorders several existing showcase entries.

Changes

NetBird showcase

Layer / File(s) Summary
NetBird showcase page and assets
docs/src/content/docs/community/showcase/netbird.md, docs/src/assets/showcase-images/*
Adds NetBird metadata, descriptive content, outbound links, and three embedded screenshots.
Showcase listing updates
docs/src/content/docs/community/showcase/index.mdx
Adds the NetBird entry and reorders the HappyTools, Packsmith, and Peirato’s Piano Keyboard entries.

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

Possibly related PRs

  • wailsapp/wails#5620: Adds a related showcase project page and updates the shared showcase overview.
  • wailsapp/wails#5656: Overlaps with the showcase index reordering and Peirato’s Piano Keyboard entry.

Suggested reviewers: leaanthony

Poem

I hopped through docs with images bright,
NetBird now joins the showcase light.
Three screenshots tucked in rows so neat,
New links and entries make it complete.
— A cheerful rabbit 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding NetBird to the showcase.
Description check ✅ Passed The description mostly matches the template and includes summary, type, testing, and checklist details.
✨ 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.

@heisbrot heisbrot changed the title Add NetBird to showcase docs: add NetBird to showcase Jul 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant