Skip to content

Add self-hosted Environment Variables page to sidebar nav#799

Merged
SunsetDrifter merged 1 commit into
mainfrom
docs/selfhosted-env-vars-nav
Jun 19, 2026
Merged

Add self-hosted Environment Variables page to sidebar nav#799
SunsetDrifter merged 1 commit into
mainfrom
docs/selfhosted-env-vars-nav

Conversation

@SunsetDrifter

@SunsetDrifter SunsetDrifter commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

The self-hosted Environment Variables reference page (src/pages/selfhosted/environment-variables.mdx, served at /selfhosted/environment-variables) had zero inbound links — it wasn't in either sidebar, no page linked to it, and there was no redirect. It was only reachable by typing the URL directly or via search, despite existing since #553.

This adds it to the Maintenance group in the docs sidebar, immediately after "Configuration Files", grouping the two configuration-reference pages together.

Note: the existing "Environment Variables" entry under the client section (/client/environment-variables) is a different page about the client daemon; this one covers self-hosted Management/Signal/Relay/Dashboard variables.

Summary by CodeRabbit

  • Documentation
    • Added "Environment Variables" link to the self-hosted NetBird documentation under the Maintenance section, positioned between Configuration Files and Scaling Your Deployment.

The /selfhosted/environment-variables reference page had no inbound
links and was only reachable by direct URL or search. Add it under
Maintenance, after Configuration Files.
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

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

Run ID: be0b4de0-cb77-4cbf-9ac0-bcd4a7732408

📥 Commits

Reviewing files that changed from the base of the PR and between f83b1b6 and eed2876.

📒 Files selected for processing (1)
  • src/components/NavigationDocs.jsx

📝 Walkthrough

Walkthrough

A new "Environment Variables" navigation link pointing to /selfhosted/environment-variables is added under the "Maintenance" group in the "SELF-HOST NETBIRD" section of docsNavigation. An existing if condition in the NavigationGroup click handler is reformatted across multiple lines with no logic changes.

Changes

Navigation Docs Update

Layer / File(s) Summary
Nav entry addition and click handler reformat
src/components/NavigationDocs.jsx
Inserts an "Environment Variables" link under the Maintenance section (between "Configuration Files" and "Scaling Your Deployment") and reformats the NavigationGroup click handler if condition with line breaks only — no logic change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • netbirdio/docs#786: Modifies the same NavigationGroup click/toggle handling logic in src/components/NavigationDocs.jsx, overhauling collapsible nav group expand behavior in the same area touched by this PR's reformat.

Suggested reviewers

  • heisbrot
  • jnfrati

Poem

🐇 A new path appears in the warren of links,
"Environment Variables" — clever, me thinks!
Between configs and scaling it finds its snug place,
While an if got some newlines to tidy its face.
Hop hop, the docs grow with each nibble of change! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding an Environment Variables page link to the sidebar navigation for the self-hosted section.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/selfhosted-env-vars-nav

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/NavigationDocs.jsx

Oops! Something went wrong! :(

ESLint: 9.39.4

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)


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 and usage tips.

@SunsetDrifter SunsetDrifter merged commit d00360e into main Jun 19, 2026
3 checks passed
@SunsetDrifter SunsetDrifter deleted the docs/selfhosted-env-vars-nav branch June 19, 2026 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants