Skip to content

docs: small doc updates based on commits sweep, add a note to contributing#252

Merged
ericksoa merged 1 commit intomainfrom
docs/minor-fixes
Mar 18, 2026
Merged

docs: small doc updates based on commits sweep, add a note to contributing#252
ericksoa merged 1 commit intomainfrom
docs/minor-fixes

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Mar 17, 2026

Summary by CodeRabbit

  • Documentation
    • Updated deployment guide to reference Quickstart installation steps
    • Added troubleshooting guidance for sandbox monitoring and cgroup configuration issues
    • Expanded command reference with preflight checks and experimental inference options
    • Updated contributor guidelines regarding pull request submission requirements and limits

@miyoungc miyoungc self-assigned this Mar 17, 2026
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Mar 17, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 17, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Contributing Guidelines
CONTRIBUTING.md
Added maintainer review requirements documentation, open PR limit (<10) policy, and warning about automated bulk submissions.
Technical Documentation
docs/deployment/deploy-to-remote-gpu.md, docs/monitoring/monitor-sandbox-activity.md, docs/reference/commands.md
Enhanced deployment guidance, added sandbox context detection notes, documented cgroup v2 preflight checks for onboarding, and included experimental local inference configuration options.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hops through docs with glee,
Guidelines clear for all to see,
Sandbox tricks and docker care,
Experimental paths laid bare!
Knowledge grows with every line,
Contributions now align!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 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 changes: documentation updates and a new note in the contributing file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/minor-fixes
📝 Coding Plan
  • Generate coding plan for human review comments

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

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2a9afbc and 94d3198.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • docs/deployment/deploy-to-remote-gpu.md
  • docs/monitoring/monitor-sandbox-activity.md
  • docs/reference/commands.md

Comment thread docs/reference/commands.md
Comment on lines +109 to +116
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
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@jacobtomlinson @ericksoa is it worth documenting? If so, would you verify the accuracy?

Copy link
Copy Markdown
Contributor

@ericksoa ericksoa left a comment

Choose a reason for hiding this comment

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

lgtm

@ericksoa ericksoa merged commit 3df5589 into main Mar 18, 2026
1 check passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
mafueee pushed a commit to mafueee/NemoClaw that referenced this pull request Mar 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants