docs: small doc updates based on commits sweep, add a note to contributing#252
docs: small doc updates based on commits sweep, add a note to contributing#252
Conversation
52a732c to
94d3198
Compare
📝 WalkthroughWalkthroughDocumentation enhancements across contributing guidelines, deployment, monitoring, and command reference files. Updates include PR submission requirements, sandbox context clarifications, cgroup v2 configuration guidance, and experimental inference options documentation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment Tip CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.Add a .trivyignore file to your project to customize which findings Trivy reports. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/commands.md`:
- Around line 113-115: The example line currently includes a shell prompt which
triggers markdownlint MD014; edit the code block so the command is shown without
the leading "$ " by replacing "$ NEMOCLAW_EXPERIMENTAL=1 nemoclaw onboard" with
"NEMOCLAW_EXPERIMENTAL=1 nemoclaw onboard" inside the existing ```console block
(look for the exact string "NEMOCLAW_EXPERIMENTAL=1 nemoclaw onboard" in the
example) so the example shows the command only and satisfies the linter.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 4d188d23-fbac-4c4a-8288-c7553a56604d
📒 Files selected for processing (4)
CONTRIBUTING.mddocs/deployment/deploy-to-remote-gpu.mddocs/monitoring/monitor-sandbox-activity.mddocs/reference/commands.md
| The onboard wizard runs a preflight check before creating the gateway. On systems with cgroup v2, such as Ubuntu 24.04 and DGX Spark, the preflight verifies that Docker is configured with `"default-cgroupns-mode": "host"` in `/etc/docker/daemon.json`. If this setting is missing, `nemoclaw onboard` exits with an error and directs you to run `nemoclaw setup-spark` to apply the fix. | ||
|
|
||
| By default, the onboard menu shows NVIDIA cloud inference options only. To enable experimental local inference options (NIM, vLLM, Ollama), set the `NEMOCLAW_EXPERIMENTAL` environment variable before running onboard: | ||
|
|
||
| ```console | ||
| $ NEMOCLAW_EXPERIMENTAL=1 nemoclaw onboard | ||
| ``` | ||
|
|
There was a problem hiding this comment.
@jacobtomlinson @ericksoa is it worth documenting? If so, would you verify the accuracy?
Summary by CodeRabbit