Skip to content

docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericksoa merged 2 commits into from
Mar 19, 2026
Merged

docs: fix the ref link to spark instruction, minor style fixes, add README to docs workflow #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c106ded
fix link and add README to docs workflow
miyoungc Mar 19, 2026
94fc05f
workaround for rendering correctly in both raw md and myst
miyoungc Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
types: [opened, synchronize, reopened]
paths:
- "docs/**"
- "README.md"
- "pyproject.toml"
- "uv.lock"
- ".github/workflows/docs.yaml"
Expand Down
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ NVIDIA NemoClaw is an open source stack that simplifies running [OpenClaw](https

Follow these steps to get started with NemoClaw and your first sandboxed OpenClaw agent.

> [!NOTE]
> **ℹ️ Note**
>
> NemoClaw creates a fresh OpenClaw instance inside the sandbox during onboarding.

<!-- start-quickstart-guide -->
Expand Down Expand Up @@ -60,8 +61,9 @@ The sandbox image is approximately 2.4 GB compressed. During image push, the Doc
| macOS | Podman | Not supported yet. NemoClaw currently depends on OpenShell support for Podman on macOS. |
| Windows WSL | Docker Desktop (WSL backend) | Supported target path |

> [!TIP]
> For DGX Spark, follow the [DGX Spark setup guide](spark-install.md). It covers Spark-specific prerequisites, such as cgroup v2 and Docker configuration, before running the standard installer.
> **💡 Tip**
>
> For DGX Spark, follow the [DGX Spark setup guide](https://github.com/NVIDIA/NemoClaw/blob/main/spark-install.md). It covers Spark-specific prerequisites, such as cgroup v2 and Docker configuration, before running the standard installer.

### Install NemoClaw and Onboard OpenClaw Agent

Expand Down Expand Up @@ -108,7 +110,8 @@ sandbox@my-assistant:~$ openclaw tui

Send a test message to the agent and verify you receive a response.

> [!NOTE]
> **ℹ️ Note**
>
> The TUI is best for interactive back-and-forth. If you need the full text of a long response (for example, large code generation output), use the CLI instead:
>
> ```console
Expand Down
Loading