Update lazy connection docs for NB_LAZY_CONN#821
Conversation
📝 WalkthroughWalkthroughTwo documentation pages are updated to replace the removed ChangesLazy Connection Variable Rename
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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
src/pages/client/environment-variables.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/manage/peers/lazy-connection.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/pages/manage/peers/lazy-connection.mdx (1)
45-45: 📐 Maintainability & Code Quality | 🔵 TrivialConsider title case consistency for the heading.
"on the agent" uses lowercase "agent" while other headings use title case (e.g., "How Automatic Disconnection Works"). Consider "Overriding Lazy Connections on the Agent" for consistency.
🤖 Prompt for 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. In `@src/pages/manage/peers/lazy-connection.mdx` at line 45, The heading text in the lazy connections docs is inconsistent with title case used elsewhere. Update the Markdown heading in the relevant section to match the existing style by capitalizing the noun in the phrase, and keep the change limited to the heading string itself so the surrounding content and structure remain unchanged.
🤖 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/manage/peers/lazy-connection.mdx`:
- Around line 42-43: The lazy connection inactivity threshold documentation is
inconsistent with the environment variable reference, so update the copy in the
lazy-connection page to match the actual default used for
NB_LAZY_CONN_INACTIVITY_THRESHOLD. Adjust the note around the inactivity
threshold text in that MDX file so it aligns with the value documented in the
environment variables page, keeping the same symbols and wording style already
used there.
---
Nitpick comments:
In `@src/pages/manage/peers/lazy-connection.mdx`:
- Line 45: The heading text in the lazy connections docs is inconsistent with
title case used elsewhere. Update the Markdown heading in the relevant section
to match the existing style by capitalizing the noun in the phrase, and keep the
change limited to the heading string itself so the surrounding content and
structure remain 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: e4c49c06-bc7a-4534-87ac-dd8414d12a7f
📒 Files selected for processing (2)
src/pages/client/environment-variables.mdxsrc/pages/manage/peers/lazy-connection.mdx
| The default inactivity threshold is <strong>60 minutes</strong>, and can be configured via the <code>NB_LAZY_CONN_INACTIVITY_THRESHOLD</code> environment variable (`60`). | ||
| </Note> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the correct default for lazy connection inactivity threshold.
# Search for the default value in source code or other docs
rg -n 'LAZY_CONN_INACTIVITY_THRESHOLD' --type=go --type=md --type=mdx -C 2Repository: netbirdio/docs
Length of output: 180
Align the inactivity threshold with the rest of the docs.
This note says the default is 60 minutes / 60, but src/pages/client/environment-variables.mdx uses 15m for NB_LAZY_CONN_INACTIVITY_THRESHOLD. Update this to match the actual default.
🤖 Prompt for 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.
In `@src/pages/manage/peers/lazy-connection.mdx` around lines 42 - 43, The lazy
connection inactivity threshold documentation is inconsistent with the
environment variable reference, so update the copy in the lazy-connection page
to match the actual default used for NB_LAZY_CONN_INACTIVITY_THRESHOLD. Adjust
the note around the inactivity threshold text in that MDX file so it aligns with
the value documented in the environment variables page, keeping the same symbols
and wording style already used there.
1 participant
Summary
Updates the lazy connection docs for the client-side rework in netbirdio/netbird#6617: the experimental opt-in is replaced by a tri-state local override, and the desktop tray toggle is removed.
NB_ENABLE_EXPERIMENTAL_LAZY_CONNwithNB_LAZY_CONN(on/off/unset) in the client environment-variables reference--enable-lazy-connectionflag, documentNB_LAZY_CONNand thelazyConnectionMDM key as local overrides over the management settingDepends on netbirdio/netbird#6617.
Summary by CodeRabbit
NB_LAZY_CONNwithon/offvalues.