Skip to content

docs: clarify network approval prerequisites - #5403

Closed
WilliamK112 wants to merge 2 commits into
NVIDIA:mainfrom
WilliamK112:wk/docs-network-approval-prereqs-5082
Closed

docs: clarify network approval prerequisites#5403
WilliamK112 wants to merge 2 commits into
NVIDIA:mainfrom
WilliamK112:wk/docs-network-approval-prereqs-5082

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarifies the network approval walkthrough prerequisites and remote sandbox command so the examples are safer to copy and run. This covers the verified placeholder/source-checkout parts of #5082 without adding unverified TUI keybinding details.

Related Issue

Addresses part of #5082

Changes

  • Add a source-checkout prerequisite for running scripts/walkthrough.sh.
  • Replace the literal remote-host placeholder with a SANDBOX_HOST variable before the ssh command.
  • Clarify that the remote host should be the host that owns the running sandbox.
  • Add basic TUI guidance to select the sandbox with the blocked request and follow the approval prompt.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • Git hooks passed during commit and push, or npx prek run --from-ref main --to-ref HEAD passes
  • Targeted tests pass for changed behavior
  • Full npm test passes (broad runtime changes only)
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Verification run:

  • npx prek run --from-ref origin/main --to-ref HEAD
  • npm run docs (passed with 0 errors; Fern reported existing warnings/upgrade notice)

Signed-off-by: WilliamK112 164879897+WilliamK112@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Added prerequisites for the network request approval walkthrough
    • Revised TUI startup instructions with environment variable configuration and an SSH command
    • Enhanced operator guidance with explicit instructions to select the sandbox showing the blocked request before responding in the TUI
    • Expanded the walkthrough with cloning and directory navigation steps for setups without an existing source checkout

@copy-pr-bot

copy-pr-bot Bot commented Jun 13, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 13, 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 314d82d4-09c3-4140-8dde-ea82750e9350

📥 Commits

Reviewing files that changed from the base of the PR and between 998d8b1 and ff82b39.

📒 Files selected for processing (1)
  • docs/network-policy/approve-network-requests.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/network-policy/approve-network-requests.mdx

📝 Walkthrough

Walkthrough

Documentation for the network policy approval walkthrough is updated to add a source-checkout prerequisite, replace static SSH instructions with a SANDBOX_HOST-parameterized command that sources the NemoClaw .env and starts the TUI, add sandbox-selection guidance before approving/denying, and insert conditional clone steps for environments without a checkout.

Changes

Network Policy Approval Walkthrough Docs

Layer / File(s) Summary
Prerequisites and TUI connection command
docs/network-policy/approve-network-requests.mdx
Adds a bullet requiring a local NemoClaw source checkout as a prerequisite, and replaces the hardcoded remote-sandbox SSH block with a SANDBOX_HOST-parameterized command that navigates to the NemoClaw directory, sources .env, and starts the OpenShell TUI.
Sandbox selection guidance and walkthrough clone steps
docs/network-policy/approve-network-requests.mdx
Adds operator guidance to select the specific sandbox showing the blocked request before responding to the approve/deny prompt, and prepends conditional git clone and cd steps to the "Run the Walkthrough" section for environments without an existing source checkout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs with care,
Adding prereqs and clone steps there.
🐇 "Set SANDBOX_HOST," the guide now reads,
"Select your sandbox, fulfill your needs!"
Source the env, approve with glee—
The TUI blooms for all to see! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: clarify network approval prerequisites' directly matches the main objective of the PR, which is to clarify prerequisites and documentation for the network approval walkthrough process.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/network-policy/approve-network-requests.mdx (1)

38-39: ⚡ Quick win

Keep each sentence on its own source line.

Lines 38-39, 55-56, and 67-69 each split a single sentence across multiple lines.
Please reflow so each sentence occupies exactly one line to match docs diff/readability conventions.

As per coding guidelines, "Keep one sentence per line in Markdown and MDX source files."

Also applies to: 55-56, 67-69

🤖 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.mdx` around lines 38 - 39,
Reflow the sentences in the file to ensure each complete sentence occupies
exactly one line in the source, following the documentation convention of one
sentence per line in Markdown/MDX files. This requires joining the split
sentences across lines 38-39, 55-56, and 67-69 so that each sentence is on a
single source line rather than being broken across multiple lines.

Source: Coding guidelines

🤖 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.mdx`:
- Around line 38-39: Reflow the sentences in the file to ensure each complete
sentence occupies exactly one line in the source, following the documentation
convention of one sentence per line in Markdown/MDX files. This requires joining
the split sentences across lines 38-39, 55-56, and 67-69 so that each sentence
is on a single source line rather than being broken across multiple lines.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 429f4aca-d54c-4d96-a9bf-ab4e12618092

📥 Commits

Reviewing files that changed from the base of the PR and between b0b1362 and 998d8b1.

📒 Files selected for processing (1)
  • docs/network-policy/approve-network-requests.mdx

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@WilliamK112
WilliamK112 force-pushed the wk/docs-network-approval-prereqs-5082 branch from 998d8b1 to ff82b39 Compare June 14, 2026 00:12
@WilliamK112

Copy link
Copy Markdown
Contributor Author

Implemented your sentence-per-line nitpick. I split the affected long/compound lines in docs/network-policy/approve-network-requests.mdx so each sentence is now on its own source line and pushed commit �c862c11 on branch wk/docs-network-approval-prereqs-5082.

@wscurran wscurran added the area: docs Documentation, examples, guides, or docs build label Jun 23, 2026
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for clarifying the source-checkout prerequisite and SANDBOX_HOST variable for the network approval walkthrough. This proposes a way to make the documentation examples safer to copy and run by adding verified prerequisites and replacing literal placeholders.


Related open issues:

@miyoungc

Copy link
Copy Markdown
Collaborator

Thanks for the work here, @WilliamK112. This helped clarify the network approval walkthrough direction.

We now have #5886 covering #5082 with the latest docs structure and follow-up review fixes, and this branch currently has merge conflicts with main, so I am closing this PR as superseded. Appreciate the contribution and the review iterations.

@miyoungc miyoungc closed this Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants