docs: remove local OpenClaw examples (Fixes #3277)#3284
Conversation
Fixes NVIDIA#3277 Signed-off-by: Deepak Jain <deepujain@gmail.com>
📝 WalkthroughWalkthroughThis PR updates documentation examples across the NemoClaw repository to remove the ChangesCLI Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
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)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@docs/get-started/quickstart.md`:
- Around line 348-350: Replace the bash fenced CLI snippet with a console fenced
block and add the $ prompt so the command appears as an interactive shell
example; update the block containing the command `openclaw agent --agent main -m
"hello" --session-id test` to use ```console and prefix the line with `$ `
instead of using ```bash.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 46893e92-5204-478d-aa1c-c48caa03d8d8
📒 Files selected for processing (7)
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md.agents/skills/nemoclaw-user-get-started/SKILL.md.agents/skills/nemoclaw-user-monitor-sandbox/SKILL.mdREADME.mddocs/deployment/deploy-to-remote-gpu.mddocs/get-started/quickstart.mddocs/monitoring/monitor-sandbox-activity.md
Signed-off-by: dejain <deepujain@gmail.com>
|
✨ Thanks for submitting this detailed PR that removes local OpenClaw examples from the quickstart and getting-started docs. This change aims to improve the documentation and onboarding experience by updating the README, quickstart, and user skills to use the supported openclaw agent form. Related open issues: |
Signed-off-by: Aaron Erickson <aerickson@nvidia.com> # Conflicts: # .agents/skills/nemoclaw-user-get-started/SKILL.md # docs/get-started/quickstart.mdx
ericksoa
left a comment
There was a problem hiding this comment.
Adversarial review found no blocking issues. The PR removes unsafe/outdated --local usage from user-facing OpenClaw examples, and the branch is mergeable with current main.
Signed-off-by: Aaron Erickson <aerickson@nvidia.com>
Summary
The quickstart and related getting-started docs still showed
openclaw agent --localin runnable NemoClaw sandbox examples. That flag is blocked inside NemoClaw-managed sandboxes, so the examples now use the supportedopenclaw agentform.Fixes #3277.
Changes
--localfrom runnableopenclaw agentcommands.Testing
npm run build:clipassed.rg -n -e '--local' README.md docs .agentsnow only finds the security/best-practices warning references.HOME=/private/tmp/nemoclaw-test-home-3277 npm testwas attempted. The local full suite still fails in existing installer/preinstall and unrelated CLI/onboard tests, includingtest/install-preflight.test.ts,test/preinstall-node-version.test.ts,test/cli.test.ts, andtest/onboard-selection.test.ts.Evidence it works
The runnable documentation paths no longer include the blocked
--localflag, while the build still compiles from this branch.Summary by CodeRabbit
--localflag from agent test inference commands.Signed-off-by: Aaron Erickson aerickson@nvidia.com