Skip to content

docs: align with current CLI, onboard recommended and setup legacy (Fixes #38)#103

Merged
cv merged 2 commits intoNVIDIA:mainfrom
deepujain:fix/38-docs-cli-align
Mar 31, 2026
Merged

docs: align with current CLI, onboard recommended and setup legacy (Fixes #38)#103
cv merged 2 commits intoNVIDIA:mainfrom
deepujain:fix/38-docs-cli-align

Conversation

@deepujain
Copy link
Copy Markdown
Contributor

@deepujain deepujain commented Mar 17, 2026

Summary

Aligns documentation with the current CLI: documents nemoclaw onboard as the recommended setup flow and nemoclaw setup as legacy, and updates deploy docs to refer to onboard.

Fixes #38.

Changes

  • docs/reference/commands.md
    • nemoclaw onboard: marked as “recommended for new installs” and added a note that the legacy nemoclaw setup command is deprecated.
    • Deploy description: “runs the nemoclaw setup” → “runs `nemoclaw onboard`”.
    • Added Legacy: nemoclaw setup subsection with deprecation note.
  • docs/deployment/deploy-to-remote-gpu.md
    • Step 3: “Runs the nemoclaw setup” → “Runs `nemoclaw onboard` (the setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs already use openshell term.)

Testing

  • npm test — all tests pass. No new unit tests (docs-only change).

Summary by CodeRabbit

  • Documentation
    • Deployment guide updated to instruct using the recommended "nemoclaw onboard" setup wizard for remote VM provisioning.
    • Added a deprecation notice: the legacy "nemoclaw setup" is deprecated; new installs should use "nemoclaw onboard".
    • Command reference revised to reflect the onboard workflow and clarify that the legacy setup remains only for backward-compatibility.

@wscurran wscurran added documentation Improvements or additions to documentation Getting Started Use this label to identify setup, installation, or onboarding issues. labels Mar 19, 2026
@wscurran
Copy link
Copy Markdown
Contributor

I've reviewed the documentation changes and see that this PR brings the docs up to date with the current CLI, which should improve the onboarding experience for new users.

@wscurran wscurran added the priority: high Important issue that should be resolved in the next release label Mar 19, 2026
@deepujain deepujain force-pushed the fix/38-docs-cli-align branch from f00a331 to a88e990 Compare March 20, 2026 00:59
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 20, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Documentation updates replace nemoclaw setup with nemoclaw onboard across deployment and command reference docs. nemoclaw onboard is documented as the recommended setup flow; the prior nemoclaw setup entry is marked deprecated and labeled as legacy for backward compatibility.

Changes

Cohort / File(s) Summary
Deployment doc
docs/deployment/deploy-to-remote-gpu.md
Changed remote VM provisioning description to state the flow runs nemoclaw onboard (was nemoclaw setup).
Command reference
docs/reference/commands.md
Marked nemoclaw onboard as recommended for new installs, added deprecation note and renamed the old section to “Legacy nemoclaw setup”, and updated nemoclaw deploy references to use nemoclaw onboard.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through lines of docs today,

Swapped an old command and cleared the way.
"Onboard" now leads the gentle trail,
The legacy echoes a quiet tale.
A nibble, a tweak — the docs set right,
I twitch my nose and bound from sight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: aligning documentation with the current CLI by marking nemoclaw onboard as recommended and nemoclaw setup as legacy.
Linked Issues check ✅ Passed The PR successfully addresses all coding requirements from issue #38: documents nemoclaw onboard as recommended, marks nemoclaw setup as deprecated, updates deployment and reference docs accordingly, and confirms npm test passes.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #38 objectives: updates to deployment and command reference docs to reflect current CLI, with no unrelated modifications.
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

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

@deepujain
Copy link
Copy Markdown
Contributor Author

Rebased onto latest main to resolve conflict in docs/reference/commands.md. Upstream added the setup-spark completion text; kept both that and the legacy nemoclaw setup deprecation section. npm test passes (docs-only change).

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.

🧹 Nitpick comments (1)
docs/reference/commands.md (1)

247-247: Remove the colon from the section title.

Line 247 uses a colon in a heading (Legacy: ...), which violates the docs title format rule.

As per coding guidelines, "No colons in titles. Flag 'Inference: Cloud and Local' — should be 'Cloud and Local Inference.'"

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/commands.md` at line 247, The section heading "Legacy:
`nemoclaw setup`" uses a colon which violates the docs title format; edit the
heading to remove the colon (change "Legacy: `nemoclaw setup`" to "Legacy
`nemoclaw setup`") so the title follows the "no colons in titles" rule and
preserve the inline code formatting.
🤖 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 247: The section heading "Legacy: `nemoclaw setup`" uses a colon which
violates the docs title format; edit the heading to remove the colon (change
"Legacy: `nemoclaw setup`" to "Legacy `nemoclaw setup`") so the title follows
the "no colons in titles" rule and preserve the inline code formatting.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c5d0b748-afe8-4389-9f25-390cc5de92bc

📥 Commits

Reviewing files that changed from the base of the PR and between dbfd78c and a88e990.

📒 Files selected for processing (2)
  • docs/deployment/deploy-to-remote-gpu.md
  • docs/reference/commands.md

@deepujain deepujain force-pushed the fix/38-docs-cli-align branch from a88e990 to 36c9b72 Compare March 20, 2026 01:16
@deepujain
Copy link
Copy Markdown
Contributor Author

Addressed CodeRabbit review comments

@wscurran wscurran assigned wscurran and kjw3 and unassigned wscurran Mar 23, 2026
@deepujain deepujain force-pushed the fix/38-docs-cli-align branch from 36c9b72 to 5f3822e Compare March 25, 2026 22:04
mafueee pushed a commit to mafueee/NemoClaw that referenced this pull request Mar 28, 2026
@jyaunches jyaunches self-requested a review March 31, 2026 21:04
@jyaunches
Copy link
Copy Markdown
Contributor

@deepujain if you could get this branch up to date with main we'll merge it!

@deepujain deepujain force-pushed the fix/38-docs-cli-align branch from 104d5ed to fe4310e Compare March 31, 2026 21:39
…ixes NVIDIA#38)

Fixes NVIDIA#38

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@deepujain
Copy link
Copy Markdown
Contributor Author

@jyaunches rebased. done

@deepujain deepujain force-pushed the fix/38-docs-cli-align branch from fe4310e to 3e3edd8 Compare March 31, 2026 21:52
@cv cv merged commit 75b8bb9 into NVIDIA:main Mar 31, 2026
1 check passed
laitingsheng pushed a commit that referenced this pull request Apr 2, 2026
…ixes #38) (#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes #38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
lakamsani pushed a commit to lakamsani/NemoClaw that referenced this pull request Apr 4, 2026
…ixes NVIDIA#38) (NVIDIA#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes NVIDIA#38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
gemini2026 pushed a commit to gemini2026/NemoClaw that referenced this pull request Apr 14, 2026
…ixes NVIDIA#38) (NVIDIA#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes NVIDIA#38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
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 Getting Started Use this label to identify setup, installation, or onboarding issues. priority: high Important issue that should be resolved in the next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants