docs: add missing debug and uninstall sections to commands.md#1074
docs: add missing debug and uninstall sections to commands.md#1074latenighthackathon wants to merge 9 commits intoNVIDIA:mainfrom
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:
📝 WalkthroughWalkthroughAdded two top-level CLI reference entries to docs/reference/commands.md for Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
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 the current code and only fix it if needed.
Inline comments:
In `@docs/reference/commands.md`:
- Around line 180-188: Update the docs for the `nemoclaw debug` command to
include the short `-o` alias for output: add `-o` to the usage line (`$ nemoclaw
debug [--quick] [--sandbox NAME] [--output FILE]`) and include `-o` in the flag
table entry for `--output FILE` so it reads something like `--output FILE | -o`
to match the CLI implementation (see `scripts/debug.sh`) and ensure docs and
parser behavior are in parity.
🪄 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: Pro
Run ID: 6de02baf-62ec-4cd9-b658-c6dbbf2d4351
📒 Files selected for processing (1)
docs/reference/commands.md
commands.md was missing documentation for nemoclaw debug and nemoclaw uninstall, which caused the doc-parity CI check to fail. Add both sections with usage examples, flag tables, and descriptions matching the actual --help output and script behavior. Closes NVIDIA#984
CodeRabbit correctly noted that scripts/debug.sh accepts -o as a short alias for --output. Update the usage line and flag table to document this.
965da48 to
40273f3
Compare
|
✨ Thanks for submitting this PR with a detailed summary, it addresses a documentation gap and proposes an addition to improve the documentation of NemoClaw, which could enhance the user experience. |
Summary
commands.md was missing documentation for nemoclaw debug and nemoclaw uninstall, which caused the doc-parity CI check to fail. Added both sections with usage examples and flag tables.
Related Issue
Closes #984
Changes
### nemoclaw debugsection with --quick, --sandbox, --output/-o flags### nemoclaw uninstallsection with --yes, --keep-openshell, --delete-models flagsType of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Doc Changes
Summary by CodeRabbit
nemoclaw debug— collects system info, container state, sandbox logs and gateway health; supports--output/-o FILE,--quick, and--sandbox NAMEto control output and scope and to save a compressed archive.nemoclaw uninstall— documents removal workflow and flags--yes,--keep-openshell, and--delete-modelsfor optional confirmation skipping, OpenShell retention, and model removal.