Skip to content

[NeMoClaw][SPark] spark-install.md doc content structure suggestion #711

@caroline-xuan

Description

@caroline-xuan

Description

Suggest to re-design doc for a better user experience

Reproduction Steps

  1. Follow up instruction in the doc https://github.com/NVIDIA/NemoClaw/blob/main/spark-install.md,
    the content structure is a little confused for user to follow up, here are some suggestions:
  2. Reorder the Sections
    Current order: Quick Start → What's Different → Prerequisites → Manual Setup → Known Issues → Verify → Architecture

Suggested order:

  1. Overview (with WIP notice)
  2. Prerequisites (check before starting)
  • Docker (pre-installed)
  • Node.js 22
  • OpenShell CLI - Added a short explanation that you do not install OpenShell separately: the installer “nemoclaw onboard” pulls it in when it is missing
  • NVIDIA API Key
  1. Quick Start (main path)
  • Clone & install
  • Run nemoclaw setup-spark
  • Done
  1. Verifying Your Install
  • openshell sandbox list
  • Test agent command
  1. Troubleshooting (problems and fixes)
  • setup-spark failed?
    → Manual Setup steps
  • Common Issues
    Issue | Status | Workaround
  • Manual Setup (fallback)
  • Fix cgroup
  • Fix permissions
  • Run onboard
  1. Technical Reference (optional, for those who want details)

Environment

Device: DGX SPARK FASTOS 1.135.16
Node.js v22.22.1
npm 10.9.4
Docker: Docker version 29.2.1, build a5c7197
OpenShell CLI: 0.0.11
NemoClaw: v0.1.0 (GitHub main branch commit ID: dbfd78c)

Debug Output

Logs

Checklist

  • I confirmed this bug is reproducible
  • I searched existing issues and this is not a duplicate

Metadata

Metadata

Assignees

Labels

Getting StartedUse this label to identify setup, installation, or onboarding issues.NV QABugs found by the NVIDIA QA TeambugSomething isn't workingdocumentationImprovements or additions to documentationenhancement: uiUse this label to identify requests to improve NemoClaw web interface.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions