docs: simplify Spark quick start and update prerequisites by paritoshd-nv · Pull Request #735 · NVIDIA/NemoClaw

paritoshd-nv · 2026-03-23T21:14:03Z

Restructures spark-install.md to move prerequisites to the top and streamlines the Quick Start to use install.sh instead of npm install -g. Removes the stale nemoclaw onboard prompt from setup-spark.sh output.

Fixes #680

Summary

Related Issue

Changes

Type of Change

Code change for a new feature, bug fix, or refactor.
Code change with doc updates.
Doc only. Prose changes without code sample modifications.
Doc only. Includes code sample changes.

Testing

npx prek run --all-files passes (or equivalently make check).
npm test passes.
make docs builds without warnings. (for doc-only changes)

Checklist

General

I have read and followed the contributing guide.
I have read and followed the style guide. (for doc-only changes)

Code Changes

Formatters applied — npx prek run --all-files auto-fixes formatting (or make format for targeted runs).
Tests added or updated for new or changed behavior.
No secrets, API keys, or credentials committed.
Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

Follows the style guide. Try running the update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docs catch up the docs for the new changes I made in this PR."
New pages include SPDX license header and frontmatter, if creating a new page.
Cross-references and links verified.

Summary by CodeRabbit

Documentation
- Added a front-loaded Prerequisites section (Docker v28.x, Node.js 22, OpenShell, NVIDIA/API note) and a simplified Quick Start that clarifies installing OpenShell, running Spark setup, then installing NemoClaw; removed outdated manual-install instructions and redundant setup claims.
Chores
- Removed a final printed “next step” prompt from the Spark setup output.

Restructures spark-install.md to move prerequisites to the top and streamlines the Quick Start to use install.sh instead of npm install -g. Removes the stale nemoclaw onboard prompt from setup-spark.sh output. Fixes NVIDIA#680 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

coderabbitai · 2026-03-23T21:20:11Z

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: 6f9533a0-509f-4fc9-bde1-d25fb8344de3

📥 Commits

Reviewing files that changed from the base of the PR and between 3a0ef51 and fa204cc.

📒 Files selected for processing (1)

spark-install.md

✅ Files skipped from review due to trivial changes (1)

spark-install.md

📝 Walkthrough

Walkthrough

Removed two final user-facing instruction lines from the Spark setup script and reorganized the Spark installation docs to add a Prerequisites section and switch Quick Start to local/install-script flows instead of recommending a global npm install.

Changes

Cohort / File(s)	Summary
Script Cleanup `scripts/setup-spark.sh`	Removed the final printed instructions that told users to run `nemoclaw onboard`; no other script logic or checks changed.
Installation Documentation `spark-install.md`	Added a top-level "Prerequisites" (Docker v28.x, Node.js 22, OpenShell CLI, NVIDIA API key prompt) and updated Quick Start to use the hosted `install.sh`, `sudo ./scripts/setup-spark.sh`, then local `./install.sh` or `curl .../nemoclaw.sh

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I hopped through scripts and nudged a line,
Prereqs first, then installs in time.
No global npm to roam,
Just local scripts to bring home.
A tiny hop—setup feels fine! 🥕

🚥 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 accurately describes the main changes: updating documentation for Spark prerequisites and simplifying the quick start process to address the npm availability issue.
Linked Issues check	✅ Passed	The PR addresses issue `#680` by removing npm dependency from the quick start (replacing 'sudo npm install -g .' with 'install.sh'), adding Docker/Node.js/API key prerequisites upfront, and removing stale prompts.
Out of Scope Changes check	✅ Passed	All changes are scoped to documentation updates and removing a stale user-facing prompt, directly addressing the installation failure issue reported in `#680`.
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.}

coderabbitai

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@spark-install.md`:
- Line 9: The "OpenShell CLI:" bullet is incomplete—update the "OpenShell CLI"
list item by adding a concise description of what the CLI is and how to use it
(e.g., purpose, key commands, installation/usage example), so the bullet no
longer ends with a colon; edit the line containing "OpenShell CLI:" to include a
one- or two-sentence explanation and a short usage hint or link to relevant
docs.
- Line 8: Update the ambiguous phrase "the install.sh" to explicitly name which
script installs Node.js (e.g., "OpenShell's install.sh" or "NemoClaw's
install.sh") so readers can distinguish between the two install scripts
referenced later; locate the Quick Start references to "OpenShell's install.sh"
and "NemoClaw's install.sh" and change the bullet "- **Node.js 22** (installed
by the install.sh)" to clearly state the exact script name that performs the
Node.js installation.
- Line 7: Update the Prerequisites section entry that currently reads
"**Docker** (pre-installed, v29.x)" to match the DGX Spark configuration by
changing the version to v28.x; locate the exact string "**Docker**
(pre-installed, v29.x)" in the document and replace "v29.x" with "v28.x" so it
is consistent with the other mentions of Docker 28.x in the file.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e2f02ec4-b27b-44b7-b277-e56160aab81b

📥 Commits

Reviewing files that changed from the base of the PR and between 7bba17d and 61f897f.

📒 Files selected for processing (2)

scripts/setup-spark.sh
spark-install.md

💤 Files with no reviewable changes (1)

scripts/setup-spark.sh

Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

* docs: simplify Spark quick start and update prerequisites Restructures spark-install.md to move prerequisites to the top and streamlines the Quick Start to use install.sh instead of npm install -g. Removes the stale nemoclaw onboard prompt from setup-spark.sh output. Fixes NVIDIA#680 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: Remove trailing-whitespace and fix coderabbit reviews Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

* docs: add local Ollama inference setup section Includes changes done in PR #735. Fixes #314, #385 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: fix style and remove stale experimental gate Remove numbered section titles and colons from the Ollama setup section in spark-install.md per doc style guide. Remove the NEMOCLAW_EXPERIMENTAL=1 gate from inference-profiles.md — local providers are GA and the gate no longer exists in source. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

* docs: simplify Spark quick start and update prerequisites Restructures spark-install.md to move prerequisites to the top and streamlines the Quick Start to use install.sh instead of npm install -g. Removes the stale nemoclaw onboard prompt from setup-spark.sh output. Fixes NVIDIA#680 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: Remove trailing-whitespace and fix coderabbit reviews Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

* docs: add local Ollama inference setup section Includes changes done in PR NVIDIA#735. Fixes NVIDIA#314, NVIDIA#385 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: fix style and remove stale experimental gate Remove numbered section titles and colons from the Ollama setup section in spark-install.md per doc style guide. Remove the NEMOCLAW_EXPERIMENTAL=1 gate from inference-profiles.md — local providers are GA and the gate no longer exists in source. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

* docs: simplify Spark quick start and update prerequisites Restructures spark-install.md to move prerequisites to the top and streamlines the Quick Start to use install.sh instead of npm install -g. Removes the stale nemoclaw onboard prompt from setup-spark.sh output. Fixes NVIDIA#680 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: Remove trailing-whitespace and fix coderabbit reviews Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

* docs: add local Ollama inference setup section Includes changes done in PR NVIDIA#735. Fixes NVIDIA#314, NVIDIA#385 Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> * docs: fix style and remove stale experimental gate Remove numbered section titles and colons from the Ollama setup section in spark-install.md per doc style guide. Remove the NEMOCLAW_EXPERIMENTAL=1 gate from inference-profiles.md — local providers are GA and the gate no longer exists in source. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> --------- Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

…IDIA#734/NVIDIA#735) CodeQL flagged the symlink-target paths in the two symlink-skip tests as insecure temp file creation (predictable `os.tmpdir() + pid` paths let a coresident attacker pre-create the target). Switch both to the existing `makeTempDir()` helper, which uses `mkdtempSync` for an unguessable directory name. Cleanup also simplifies to the afterEach hook since both temp dirs are now tracked in `tmpDirs`. Tests still pass (16/16). Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>

paritoshd-nv and others added 2 commits March 23, 2026 21:11

Merge branch 'main' into docs/spark-setup-update1

61f897f

coderabbitai Bot reviewed Mar 23, 2026

View reviewed changes

Comment thread spark-install.md Outdated

Comment thread spark-install.md

Comment thread spark-install.md Outdated

paritoshd-nv force-pushed the docs/spark-setup-update1 branch from 382bd39 to 3a0ef51 Compare March 23, 2026 21:30

docs: Remove trailing-whitespace and fix coderabbit reviews

fa204cc

Signed-off-by: Paritosh Dixit <paritoshd@nvidia.com>

paritoshd-nv force-pushed the docs/spark-setup-update1 branch from 3a0ef51 to fa204cc Compare March 23, 2026 21:32

paritoshd-nv requested review from ericksoa and kjw3 March 23, 2026 21:36

kjw3 approved these changes Mar 23, 2026

View reviewed changes

kjw3 merged commit ee8b5eb into NVIDIA:main Mar 23, 2026
5 of 6 checks passed

paritoshd-nv mentioned this pull request Mar 24, 2026

docs: add local Ollama inference setup section #822

Merged

16 tasks

wscurran added the chore Build, CI, dependency, or tooling maintenance label Jun 8, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: simplify Spark quick start and update prerequisites#735

docs: simplify Spark quick start and update prerequisites#735
kjw3 merged 3 commits into
NVIDIA:mainfrom
paritoshd-nv:docs/spark-setup-update1

paritoshd-nv commented Mar 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Mar 23, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

paritoshd-nv commented Mar 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Changes

Type of Change

Testing

Checklist

General

Code Changes

Doc Changes

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

paritoshd-nv commented Mar 23, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 23, 2026 •

edited

Loading