Skip to content

chore(docs): add debug and uninstall to commands reference - #1082

Merged
ericksoa merged 2 commits into
mainfrom
chore/docs-commands-drift
Mar 30, 2026
Merged

chore(docs): add debug and uninstall to commands reference#1082
ericksoa merged 2 commits into
mainfrom
chore/docs-commands-drift

Conversation

@ericksoa

@ericksoa ericksoa commented Mar 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add nemoclaw debug and nemoclaw uninstall to docs/reference/commands.md
  • Fixes the check-docs.sh CLI parity check which found 15 commands in --help but only 13 headings in the docs

Test plan

  • check-docs.sh --only-cli passes (verified locally: 15/15 parity)
  • cloud-experimental-e2e Phase 5f passes

Summary by CodeRabbit

  • Documentation
    • Added CLI reference for nemoclaw debug describing diagnostics collection, --quick, --sandbox, and --output options.
    • Added CLI reference for nemoclaw uninstall describing removal behavior and flags --yes, --keep-openshell, and --delete-models, with flag descriptions.

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.
@ericksoa
ericksoa requested a review from cv March 30, 2026 03:16
@coderabbitai

coderabbitai Bot commented Mar 30, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ffaa0954-7164-4694-985b-5adbde4b2b54

📥 Commits

Reviewing files that changed from the base of the PR and between 7cdcc03 and fee0dfc.

📒 Files selected for processing (1)
  • docs/reference/commands.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/reference/commands.md

📝 Walkthrough

Walkthrough

Added documentation for two new CLI commands: nemoclaw debug (collects diagnostics, supports --quick, --sandbox NAME, --output PATH) and nemoclaw uninstall (removes sandboxes and gateway, runs bundled or downloaded uninstall.sh, supports --yes, --keep-openshell, --delete-models).

Changes

Cohort / File(s) Summary
CLI Command Documentation
docs/reference/commands.md
Added nemoclaw debug docs (diagnostics collection, --quick, --sandbox, --output) and nemoclaw uninstall docs (removal flow, runs uninstall.sh locally or downloads from GitHub, flags --yes, --keep-openshell, --delete-models).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I dug a trail of helpful notes,
Two commands tucked in tidy quotes,
Debug to peek, uninstall to part,
A little hop from my doc-writing heart. 🥕✨

🚥 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 change: adding documentation for two CLI commands (debug and uninstall) to the commands reference 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 chore/docs-commands-drift

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between d9d5ba8 and 7cdcc03.

📒 Files selected for processing (1)
  • docs/reference/commands.md

@ericksoa
ericksoa merged commit 64fd127 into main Mar 30, 2026
11 checks passed
laitingsheng pushed a commit that referenced this pull request Apr 2, 2026
* 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
lakamsani pushed a commit to lakamsani/NemoClaw that referenced this pull request Apr 4, 2026
* 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
gemini2026 pushed a commit to gemini2026/NemoClaw that referenced this pull request Apr 14, 2026
* 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
@wscurran wscurran added the chore Build, CI, dependency, or tooling maintenance label Jun 8, 2026
@cv
cv deleted the chore/docs-commands-drift branch June 28, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants