docs(network-policy): clarify approval and preset persistence#3799
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughDocs clarify that TUI approvals are session-only (not persisted) and distinguish merging presets into the baseline YAML vs using ChangesNetwork Policy Persistence and Operation
Sequence Diagram(s) sequenceDiagram
participant Operator
participant Repo as openclaw-sandbox.yaml
participant NemoClawCLI as "nemoclaw <name> policy-add"
participant Sandbox as RunningSandbox
Operator->>Repo: edit/merge preset into openclaw-sandbox.yaml
Repo->>NemoClawCLI: run `nemoclaw onboard` / rebuild
NemoClawCLI->>Sandbox: apply baseline during sandbox creation
Operator->>NemoClawCLI: run `nemoclaw <name> policy-add`
NemoClawCLI->>Sandbox: fetch live policy, merge preset, set live policy
Estimated code review effort: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/network-policy/approve-network-requests.md (1)
69-70: ⚡ Quick winKeep each sentence on a single source line for docs diffs.
Lines 69-70, 74-75, and 82-83 split single sentences across multiple lines; this breaks the docs formatting rule for sentence-per-line source formatting.
Suggested edit
-To keep an endpoint allowed after a restart, update the policy YAML or apply a preset as described in -[Customize the Sandbox Network Policy](customize-network-policy.md). +To keep an endpoint allowed after a restart, update the policy YAML or apply a preset as described in [Customize the Sandbox Network Policy](customize-network-policy.md). -From the NemoClaw repository root, run the walkthrough script after you have onboarded at least one -sandbox and it is reachable: +From the NemoClaw repository root, run the walkthrough script after you have onboarded at least one sandbox and it is reachable: -The walkthrough requires tmux and the `NVIDIA_API_KEY` environment variable, and it assumes an -existing sandbox to attach to. +The walkthrough requires tmux and the `NVIDIA_API_KEY` environment variable, and it assumes an existing sandbox to attach to.As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
Also applies to: 74-75, 82-83
🤖 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 `@docs/network-policy/approve-network-requests.md` around lines 69 - 70, The sentences that are currently split across lines must be converted to one sentence per source line: put the entire sentence "To keep an endpoint allowed after a restart, update the policy YAML or apply a preset as described in [Customize the Sandbox Network Policy](customize-network-policy.md)." on a single line, and similarly join the sentence currently split across lines 74-75 into one line and the sentence split across lines 82-83 into one line so each sentence occupies exactly one source line.docs/network-policy/customize-network-policy.md (1)
57-58: ⚡ Quick winUse single-line source sentences in these new paragraphs.
Lines 57-58 and 60-61 wrap each sentence across multiple lines; please keep each sentence on one source line to match docs formatting standards.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
Also applies to: 60-61
🤖 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 `@docs/network-policy/customize-network-policy.md` around lines 57 - 58, Split the wrapped sentences so each sentence occupies its own source line: locate the paragraph that begins "If you want a built-in preset to be part of the baseline policy, merge its `network_policies` entries into this file and re-run `nemoclaw onboard`" and the nearby paragraph two lines below, and reflow them so every sentence is on a single source line (one sentence per line) to conform to the docs formatting standard.
🤖 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.
Nitpick comments:
In `@docs/network-policy/approve-network-requests.md`:
- Around line 69-70: The sentences that are currently split across lines must be
converted to one sentence per source line: put the entire sentence "To keep an
endpoint allowed after a restart, update the policy YAML or apply a preset as
described in [Customize the Sandbox Network
Policy](customize-network-policy.md)." on a single line, and similarly join the
sentence currently split across lines 74-75 into one line and the sentence split
across lines 82-83 into one line so each sentence occupies exactly one source
line.
In `@docs/network-policy/customize-network-policy.md`:
- Around line 57-58: Split the wrapped sentences so each sentence occupies its
own source line: locate the paragraph that begins "If you want a built-in preset
to be part of the baseline policy, merge its `network_policies` entries into
this file and re-run `nemoclaw onboard`" and the nearby paragraph two lines
below, and reflow them so every sentence is on a single source line (one
sentence per line) to conform to the docs formatting standard.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f3f32751-dea2-4c5d-bef8-c00a80a0802a
📒 Files selected for processing (2)
docs/network-policy/approve-network-requests.mddocs/network-policy/customize-network-policy.md
Removed duplicate lines for clarity in the documentation.
|
✨ Thanks for submitting this detailed PR about clarifying network policy approval and preset persistence in the documentation. This proposes a way to improve the documentation by separating baseline edits from live preset application guidance and adding walkthrough prerequisites. Related open issues:
|
Signed-off-by: Aaron Erickson <aerickson@nvidia.com>
ericksoa
left a comment
There was a problem hiding this comment.
Looks good. I verified the live versus persistent policy semantics, updated the rendered Fern MDX pages so the public docs receive the clarification, and reran focused docs validation: git diff --check, docs:strict, docs-to-skills dry runs, and local link checks.
|
Cool! thanks a ton @ericksoa! |
Summary
Clarifies that TUI approvals are session-only and points readers to persistent policy options.
Updates the walkthrough instructions to note repo-root and sandbox prerequisites, and separates baseline edits from live
policy-addusage.Related Issue
Fixes #3772
Fixes #3773
Fixes #3774
Changes
approve-network-requests.md.approve-network-requests.md.customize-network-policy.md.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: Suryaansh Suryaansh.aa@gmail.com
Summary by CodeRabbit