Skip to content

docs: link DGX Spark setup guide from README#369

Merged
miyoungc merged 2 commits intomainfrom
fix/issue-321-readme-spark-link
Mar 19, 2026
Merged

docs: link DGX Spark setup guide from README#369
miyoungc merged 2 commits intomainfrom
fix/issue-321-readme-spark-link

Conversation

@ericksoa
Copy link
Copy Markdown
Contributor

@ericksoa ericksoa commented Mar 19, 2026

Closes #321.

Summary

  • Add a tip box before the install section directing DGX Spark users to spark-install.md

Problem

Spark users following the main Quick Start hit opaque errors because Spark-specific prerequisites (cgroup v2, Docker configuration) are only documented in spark-install.md, which the README never links to.

Summary by CodeRabbit

  • Documentation
    • Added a callout in the "Container Runtime Support" section advising DGX Spark users to complete the Spark setup guide before running the standard installer, and calling out Spark-specific prerequisites (e.g., cgroup v2 and Docker configuration). No other installation instructions or documentation structure were changed.

Closes #321.

Spark users following the main Quick Start hit opaque errors because
the Spark-specific prerequisites (cgroup v2, Docker config) are only
documented in spark-install.md. Add a tip box before the install
section directing Spark users to the right guide.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

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: 4b864962-dc2a-4a05-9de1-e9a60b6f1084

📥 Commits

Reviewing files that changed from the base of the PR and between a601d45 and 581ca28.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README.md now includes an inline tip in the "Container Runtime Support" section advising DGX Spark users to consult spark-install.md before running the standard installer, noting Spark-specific prerequisites (e.g., cgroup v2 and Docker configuration).

Changes

Cohort / File(s) Summary
Documentation Update
README.md
Added an inline tip under "Container Runtime Support" directing DGX Spark users to follow spark-install.md (Spark-specific prerequisites) before running the standard installer.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A tiny footnote hops into view,
"Spark users, check spark-install first!" — it's true.
A nudge for cgroups and Docker to align,
So installations hum and errors decline. ✨

🚥 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 and concisely summarizes the main change: adding a link to the DGX Spark setup guide from the README, which directly addresses the PR's primary objective.
Linked Issues check ✅ Passed The PR fully addresses issue #321 by adding a callout tip linking DGX Spark users to spark-install.md from the README, making Spark-specific prerequisites discoverable and preventing users from encountering opaque errors.
Out of Scope Changes check ✅ Passed All changes are in-scope: only a callout tip was added to the README to link to spark-install.md. No extraneous modifications or unrelated changes are present.
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 fix/issue-321-readme-spark-link
📝 Coding Plan
  • Generate coding plan for human review comments

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

@wscurran wscurran added documentation Improvements or additions to documentation Platform: DGX Spark Support for DGX Spark labels Mar 19, 2026
Comment thread README.md Outdated
@miyoungc miyoungc merged commit 3ba517d into main Mar 19, 2026
3 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* docs: link DGX Spark setup guide from README

Closes NVIDIA#321.

Spark users following the main Quick Start hit opaque errors because
the Spark-specific prerequisites (cgroup v2, Docker config) are only
documented in spark-install.md. Add a tip box before the install
section directing Spark users to the right guide.

* Update README.md

---------

Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* docs: link DGX Spark setup guide from README

Closes NVIDIA#321.

Spark users following the main Quick Start hit opaque errors because
the Spark-specific prerequisites (cgroup v2, Docker config) are only
documented in spark-install.md. Add a tip box before the install
section directing Spark users to the right guide.

* Update README.md

---------

Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>
mafueee pushed a commit to mafueee/NemoClaw that referenced this pull request Mar 28, 2026
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 Platform: DGX Spark Support for DGX Spark

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README does not link to Spark installation guide

3 participants