Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion ci/platform-matrix.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"status": "tested",
"prd_priority": "P1",
"ci_tested": true,
"notes": "Use the standard installer and `nemoclaw onboard`. For an end-to-end walkthrough with local Ollama inference, see the [NVIDIA Spark playbook](https://build.nvidia.com/spark/nemoclaw)."
"notes": "Use the standard installer and `$$nemoclaw onboard`. For an end-to-end walkthrough with local Ollama inference, see the [NVIDIA Spark playbook](https://build.nvidia.com/spark/nemoclaw)."
},
{
"name": "Windows WSL2",
Expand Down
27 changes: 20 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,18 +145,31 @@ Fern `.mdx` pages are the source for generated user skills. Legacy `.md` pages m
## Agent Variant Generation

Some Fern pages appear in both the OpenClaw and Hermes guide variants.
When the page content is the same except for the host CLI binary, write one source page and use `$$nemoclaw` as a build-time placeholder.
Do not duplicate fenced code blocks or inline command examples only to switch between `nemoclaw` and `nemohermes`.
The `scripts/sync-agent-variant-docs.ts` script reads `docs/index.yml` and renders variant-specific copies for every page that appears in both guide variants before Fern validates or publishes the site.
The source pages stay in their normal `docs/` locations, and generated pages are written under `docs/_build/agent-variants/`, which is ignored by Git.
Navigation in `docs/index.yml` points Fern at generated pages for shared entries so Fern still renders normal fenced code blocks with copy buttons and syntax highlighting.
OpenClaw-only or Hermes-only pages stay as source pages in navigation.

The `scripts/sync-agent-variant-docs.ts` script renders variant-specific pages before Fern validates or publishes the site.
For the sandbox lifecycle guide, the source page remains at `docs/manage-sandboxes/lifecycle.mdx`.
The generated OpenClaw and Hermes pages are written under `docs/_build/agent-variants/`, which is ignored by Git.
Navigation in `docs/index.yml` points Fern at those generated pages so Fern still renders normal fenced code blocks with copy buttons and syntax highlighting.
When shared page content is the same except for the host CLI binary, write one source page and use `$$nemoclaw` as a build-time placeholder.
Do not duplicate fenced code blocks or inline command examples only to switch between `nemoclaw` and `nemohermes`.
Use literal command names on those single-variant pages rather than `$$nemoclaw`, because no generated page will rewrite the placeholder.

Run `npm run docs:sync-agent-variants` after editing a shared variant source page.
Run `npm run docs:sync-agent-variants` after editing shared variant source pages or navigation.
Run `npm run docs` before opening a PR to verify the generated pages, rewritten relative links, and Fern navigation.
If content differs by behavior, setup flow, state layout, or agent-specific wording, keep using `<AgentOnly>` blocks for that content.

## Route-Style Links

Fern links between docs pages should use route-style paths, not filesystem paths.
Route-style paths omit the `.mdx` extension and follow the page slugs declared in `docs/index.yml`.
For example, a source page under `docs/get-started/` should link to the OpenClaw quickstart as `../quickstart`, not `quickstart.mdx`.
The published route comes from the navigation hierarchy and page `slug`, not directly from the file path.

This matters for generated agent variants because shared source pages may not appear directly in `docs/index.yml`.
The navigation can point Fern at generated pages under `docs/_build/agent-variants/`, while the source MDX remains in its normal folder.
The link checker maps those generated nav entries back to their source paths when validating route-style links.
Do not convert route-style links to `.mdx` file links just to satisfy a local filesystem check.

## Doc-Only PR Verification

Doc-only pull requests do not need the full test suite by default.
Expand Down
2 changes: 1 addition & 1 deletion docs/about/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Navigate to the following topics to learn more about NemoClaw and how to install

- [Architecture Overview](how-it-works) to understand how NemoClaw works.
- [Ecosystem](ecosystem-hermes) to understand how Hermes, OpenShell, and NemoClaw relate in the wider stack, and when to use NemoClaw versus OpenShell.
- [Quickstart with Hermes](../get-started/quickstart-hermes) to install NemoClaw and run your first Hermes sandbox with `nemohermes`.
- [Quickstart with Hermes](../get-started/quickstart-hermes) to install NemoClaw and run your first Hermes sandbox with `$$nemoclaw`.
- [Agent Skills](../resources/agent-skills) to load NemoClaw guidance into an AI coding assistant.
- [Inference Options](../inference/inference-options) to check the inference providers that NemoClaw supports and how inference routing works.

Expand Down
72 changes: 36 additions & 36 deletions docs/about/release-notes.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/deployment/deploy-to-remote-gpu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,4 @@ nemoclaw deploy <instance-name>

- [Set Up Messaging Channels](../manage-sandboxes/messaging-channels) to connect Telegram, Discord, or Slack through OpenShell-managed channel messaging.
- [Monitor Sandbox Activity](../monitoring/monitor-sandbox-activity) for sandbox monitoring tools.
- [Commands](../reference/commands) for the full `deploy` command reference.
- [`nemoclaw deploy`](../reference/commands#nemoclaw-deploy) for the full `deploy` command reference.
8 changes: 4 additions & 4 deletions docs/get-started/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ On macOS, NemoClaw uses the Docker-driver OpenShell gateway path with Docker Des
You do not need to install or sign a separate OpenShell VM driver helper for standard macOS onboarding.

<Warning title="OpenShell Lifecycle">
For NemoClaw-managed environments, use `nemoclaw onboard` when you need to create or recreate the OpenShell gateway or sandbox.
Avoid `openshell self-update`, `npm update -g openshell`, `openshell gateway start --recreate`, or `openshell sandbox create` directly unless you intend to manage OpenShell separately and then rerun `nemoclaw onboard`.
For NemoClaw-managed environments, use `$$nemoclaw onboard` when you need to create or recreate the OpenShell gateway or sandbox.
Avoid `openshell self-update`, `npm update -g openshell`, `openshell gateway start --recreate`, or `openshell sandbox create` directly unless you intend to manage OpenShell separately and then rerun `$$nemoclaw onboard`.
</Warning>

<Note title="Docker Storage Driver">
On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled cluster image to bypass a kernel-level nested-overlay limitation in k3s.
On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `$$nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled cluster image to bypass a kernel-level nested-overlay limitation in k3s.
You do not need manual setup.
Refer to the [troubleshooting guide](../reference/troubleshooting) for the override knobs and a manual `daemon.json` alternative.
</Note>
Expand All @@ -72,7 +72,7 @@ The table comes from [`ci/platform-matrix.json`](https://github.com/NVIDIA/NemoC
|----|-------------------|--------|-------|
| Linux | Docker | Tested | Primary tested path. |
| macOS (Apple Silicon) | Colima, Docker Desktop | Tested with limitations | Install Xcode Command Line Tools (`xcode-select --install`) and start the runtime before running the installer. |
| DGX Spark | Docker | Tested | Use the standard installer and `nemoclaw onboard`. For an end-to-end walkthrough with local Ollama inference, see the [NVIDIA Spark playbook](https://build.nvidia.com/spark/nemoclaw). |
| DGX Spark | Docker | Tested | Use the standard installer and `$$nemoclaw onboard`. For an end-to-end walkthrough with local Ollama inference, see the [NVIDIA Spark playbook](https://build.nvidia.com/spark/nemoclaw). |
| Windows WSL2 | Docker Desktop (WSL backend) | Tested with limitations | Requires WSL2 with Docker Desktop backend. |
{/* platform-matrix:end */}

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/windows-preparation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ During onboarding, NemoClaw can use an already-running Windows-host daemon, star
If the installer offers express install on WSL, accepting it selects this Windows-host Ollama path automatically.
When Ollama runs on the Windows host, NemoClaw detects it from WSL through `host.docker.internal` and pulls missing models through the Ollama HTTP API.
Do not run both the Windows and WSL Ollama instances on port `11434` at the same time.
Use one instance, or move one of them to a different port before running `nemoclaw onboard`.
Use one instance, or move one of them to a different port before running `$$nemoclaw onboard`.

## Next Step

Expand Down
Loading
Loading