docs: align with current CLI, onboard recommended and setup legacy (Fixes #38)#103
docs: align with current CLI, onboard recommended and setup legacy (Fixes #38)#103cv merged 2 commits intoNVIDIA:mainfrom
Conversation
|
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. |
f00a331 to
a88e990
Compare
|
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:
📝 WalkthroughWalkthroughDocumentation updates replace Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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 |
|
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). |
There was a problem hiding this comment.
🧹 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
📒 Files selected for processing (2)
docs/deployment/deploy-to-remote-gpu.mddocs/reference/commands.md
a88e990 to
36c9b72
Compare
|
Addressed CodeRabbit review comments |
36c9b72 to
5f3822e
Compare
|
@deepujain if you could get this branch up to date with main we'll merge it! |
104d5ed to
fe4310e
Compare
|
@jyaunches rebased. done |
fe4310e to
3e3edd8
Compare
…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>
…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>
…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>
Summary
Aligns documentation with the current CLI: documents
nemoclaw onboardas the recommended setup flow andnemoclaw setupas legacy, and updates deploy docs to refer to onboard.Fixes #38.
Changes
nemoclaw onboard: marked as “recommended for new installs” and added a note that the legacynemoclaw setupcommand is deprecated.nemoclaw setupsubsection with deprecation note.(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