chore(docs): add debug and uninstall to commands reference - #1082
Conversation
check-docs.sh found 15 commands in --help but only 13 headings in docs/reference/commands.md. Add the missing nemoclaw debug and nemoclaw uninstall entries.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded documentation for two new CLI commands: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/reference/commands.md (2)
197-197: Use second-person phrasing in command behavior text.Line 197 is written in third person; please rewrite to address the reader directly (for example, “If available, you run…” style) to match docs voice.
As per coding guidelines, for
docs/**: "Second person ("you") when addressing the reader."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` at line 197, Rewrite the third-person sentence "Runs the bundled `uninstall.sh` if available, otherwise downloads it from GitHub." to second-person voice so it addresses the reader directly (e.g., "If a bundled `uninstall.sh` is available, you run it; otherwise, you download it from GitHub.") and ensure the meaning remains identical; update the sentence in docs/reference/commands.md where that exact line appears.
206-206: Fix product name casing in prose (OpenShell).Line 206 uses “openshell” in prose; use “OpenShell” for correct product casing.
As per coding guidelines, for
docs/**word list: "OpenShell | Incorrect: openshell (in prose)."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` at line 206, Update the prose for the `--keep-openshell` flag so the product name uses correct casing: replace "Leave the openshell binary installed" with "Leave the OpenShell binary installed" (keep the flag token `--keep-openshell` unchanged); ensure this change follows the docs word list rule for OpenShell.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/reference/commands.md`:
- Line 197: Rewrite the third-person sentence "Runs the bundled `uninstall.sh`
if available, otherwise downloads it from GitHub." to second-person voice so it
addresses the reader directly (e.g., "If a bundled `uninstall.sh` is available,
you run it; otherwise, you download it from GitHub.") and ensure the meaning
remains identical; update the sentence in docs/reference/commands.md where that
exact line appears.
- Line 206: Update the prose for the `--keep-openshell` flag so the product name
uses correct casing: replace "Leave the openshell binary installed" with "Leave
the OpenShell binary installed" (keep the flag token `--keep-openshell`
unchanged); ensure this change follows the docs word list rule for OpenShell.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8ed5fd09-ce5d-4931-adca-792cfb9d4951
📒 Files selected for processing (1)
docs/reference/commands.md
* chore(docs): add debug and uninstall to commands reference check-docs.sh found 15 commands in --help but only 13 headings in docs/reference/commands.md. Add the missing nemoclaw debug and nemoclaw uninstall entries. * chore(docs): add missing --sandbox flag to debug entry
* chore(docs): add debug and uninstall to commands reference check-docs.sh found 15 commands in --help but only 13 headings in docs/reference/commands.md. Add the missing nemoclaw debug and nemoclaw uninstall entries. * chore(docs): add missing --sandbox flag to debug entry
* chore(docs): add debug and uninstall to commands reference check-docs.sh found 15 commands in --help but only 13 headings in docs/reference/commands.md. Add the missing nemoclaw debug and nemoclaw uninstall entries. * chore(docs): add missing --sandbox flag to debug entry
Summary
nemoclaw debugandnemoclaw uninstalltodocs/reference/commands.mdcheck-docs.shCLI parity check which found 15 commands in--helpbut only 13 headings in the docsTest plan
check-docs.sh --only-clipasses (verified locally: 15/15 parity)cloud-experimental-e2ePhase 5f passesSummary by CodeRabbit
nemoclaw debugdescribing diagnostics collection,--quick,--sandbox, and--outputoptions.nemoclaw uninstalldescribing removal behavior and flags--yes,--keep-openshell, and--delete-models, with flag descriptions.