Skip to content
Merged
44 changes: 35 additions & 9 deletions .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: nemoclaw-contributor-update-docs
description: Scan recent git commits for changes that affect user-facing behavior, then draft or update the corresponding documentation pages. Use when docs have fallen behind code changes, after a batch of features lands, or when preparing a release. Trigger keywords - update docs, draft docs, docs from commits, sync docs, catch up docs, doc debt, docs behind, docs drift.
description: Scan recent git commits for changes that affect user-facing behavior, then draft or update the corresponding documentation pages and refresh generated user skills for release prep. Use when docs have fallen behind code changes, after a batch of features lands, during daily release prep, or when preparing a release. Trigger keywords - update docs, draft docs, docs from commits, sync docs, catch up docs, doc debt, docs behind, docs drift, release prep docs, refresh user skills.
---

# Update Docs from Commits
Expand All @@ -16,6 +16,7 @@ Scan recent git history for commits that affect user-facing behavior and draft d

- After a batch of features or fixes has landed and docs may be stale.
- Before a release, to catch any doc gaps.
- During daily release prep, before opening the docs refresh PR.
- When a contributor asks "what docs need updating?"

## Step 0: Load the Skip List
Expand Down Expand Up @@ -154,7 +155,20 @@ After drafting all updates, present a summary to the user:
- `test: add launch command test` (def5678) — test-only change.
```

## Step 7: Build and Verify
## Step 7: Apply Release Prep Updates

Skip this step when the user only asked for ordinary doc catch-up and no release prep is involved.
Comment thread
miyoungc marked this conversation as resolved.

If the user invoked this skill for release prep, finish the release-specific doc work before verification:

1. Make any requested doc version bumps in `versions1.json` and `project.json` in the `docs/` directory.
2. Refresh the NemoClaw user skills:

```bash
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user
```

## Step 9: Build and Verify

After making changes, build the docs locally:

Expand All @@ -167,15 +181,18 @@ Check for:
- Build warnings or errors.
- Broken cross-references.
- Correct rendering of new content.
- Generated skill changes that do not correspond to source doc changes.

## Step 8: Label PRs
## Step 10: Open the Docs PR

When the workflow produces a pull request, apply the `documentation` label so reviewers can identify doc-only changes:
Commit changes and open a pull request with a concise summary of the doc updates and a source summary that links each identified merged PR to its matching doc page. Include the PR number, affected doc page, links, and description of the doc change in this shape:

```bash
gh pr edit <number> --add-label documentation
```markdown
- #<doc-impacting-PR-number> -> `docs/path.md`: Description of the doc change reflecting the source code changes in the PR.
```

Apply the `documentation` label so reviewers can identify doc-only changes.

## Tips

- When in doubt about whether a commit needs a doc update, check if the commit message references a CLI flag, config option, or user-visible behavior.
Expand All @@ -192,6 +209,15 @@ User says: "Catch up the docs for everything merged since v0.1.0."
2. Filter to `feat`, `fix`, `refactor`, `perf` commits touching user-facing code.
3. Map each to a doc page.
4. Read the commit diffs and current doc pages.
5. Draft updates following the style guide.
6. Present the summary.
7. Build with `make docs` to verify.
5. Draft doc updates reflecting the source code changes in the commits following the style guide.
6. **Release prep only:** Apply release-prep version bumps if the user requested release prep.
7. **Release prep only:** Run `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user`.
8. Present the summary.
9. Build with `make docs` to verify.
10. **Release prep only:** Commit changes and open a pull request with a concise summary of the doc updates and a source summary that links each identified merged PR to its matching doc page. Include the PR number, affected doc page, links, and description of the doc change in this shape:

```markdown
- #<doc-impacting-PR-number> -> `docs/path.md`: Description of the doc change reflecting the source code changes in the PR.
```

11.Apply the `documentation` label so reviewers can identify doc-only changes.
2 changes: 1 addition & 1 deletion .agents/skills/nemoclaw-skills-guide/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Covers creating pull requests that follow the project template and drafting docu
| Skill | Summary |
|-------|---------|
| `nemoclaw-contributor-create-pr` | Create GitHub pull requests that follow the NemoClaw PR template, including pre-PR checks, conventional commit titles, and DCO sign-off. |
| `nemoclaw-contributor-update-docs` | Scan recent git commits for user-facing changes and draft or update the corresponding documentation pages. |
| `nemoclaw-contributor-update-docs` | Scan recent git commits for user-facing changes, draft or update documentation pages, and refresh generated user skills during release prep. |

## Getting Started

Expand Down
35 changes: 29 additions & 6 deletions .agents/skills/nemoclaw-user-configure-inference/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ description: "Connects NemoClaw to a local inference server. Use when setting up
## Prerequisites

- NemoClaw installed.
- A local model server running, or an Ollama setup that the NemoClaw onboard wizard can use, start, or install.
- A local model server running, or a supported Ollama, vLLM, or NIM setup that the NemoClaw onboard wizard can use, start, or install.

NemoClaw can route inference to a model server running on your machine instead of a cloud API.
This page covers Ollama, compatible-endpoint paths for other servers, and two experimental options for vLLM and NVIDIA NIM.
This page covers Ollama, compatible-endpoint paths for other servers, and experimental managed options for vLLM and NVIDIA NIM.

All approaches use the same `inference.local` routing model.
The agent inside the sandbox never connects to your model server directly.
Expand Down Expand Up @@ -206,9 +206,10 @@ $ NEMOCLAW_PROVIDER=anthropicCompatible \
nemoclaw onboard --non-interactive
```

## Step 4: vLLM Auto-Detection (Experimental)
## Step 4: vLLM (Experimental)

When vLLM is already running on `localhost:8000`, NemoClaw can detect it automatically and query the `/v1/models` endpoint to determine the loaded model.
On supported Linux hosts with NVIDIA GPUs, the onboard wizard can also install or start a managed vLLM container for you.

Set the experimental flag and run onboard.

Expand All @@ -217,21 +218,43 @@ $ NEMOCLAW_EXPERIMENTAL=1 nemoclaw onboard
```

Select **Local vLLM [experimental]** from the provider list.
NemoClaw detects the running model and validates the endpoint.
If vLLM is already running, NemoClaw detects the running model and validates the endpoint.
If vLLM is not running and your host matches a managed profile, select the **Install vLLM** or **Start vLLM** entry.
NemoClaw pulls the vLLM image, downloads model weights into `~/.cache/huggingface`, starts the `nemoclaw-vllm` container on `localhost:8000`, and prints progress markers while the model loads.
The first run can take 10 to 30 minutes.
Later runs reuse the cached image and model weights.

Managed vLLM uses these profiles:

| Host profile | Default model |
|---|---|
| DGX Spark | `Qwen/Qwen3.6-27B-FP8` |
| DGX Station | `Qwen/Qwen3.6-27B-FP8` |
| Linux with an NVIDIA GPU | `nvidia/NVIDIA-Nemotron-3-Nano-4B-FP8` |

> **Note:** NemoClaw forces the `chat/completions` API path for vLLM.
> The vLLM `/v1/responses` endpoint does not run the `--tool-call-parser`, so tool calls arrive as raw text.

### Non-Interactive Setup

Use an already-running vLLM server:

```console
$ NEMOCLAW_EXPERIMENTAL=1 \
NEMOCLAW_PROVIDER=vllm \
nemoclaw onboard --non-interactive
```

NemoClaw auto-detects the model from the running vLLM instance.
To override the model, set `NEMOCLAW_MODEL`.
Install or start managed vLLM when a supported profile is detected:

```console
$ NEMOCLAW_EXPERIMENTAL=1 \
NEMOCLAW_PROVIDER=install-vllm \
nemoclaw onboard --non-interactive
```

NemoClaw records the model returned by vLLM's `/v1/models` endpoint.
Start vLLM with the model you want before onboarding if you manage the server yourself.

## Step 5: NVIDIA NIM (Experimental)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ NemoClaw uses provider-specific local tokens for those routes, and rebuilds of l
The onboard wizard presents the following provider options by default.
The first six are always available.
Ollama appears when it is installed or running on the host.
Experimental local vLLM appears when you opt in and NemoClaw detects either a running vLLM server or a supported NVIDIA GPU host profile.

| Option | Description | Curated models |
|--------|-------------|----------------|
Expand Down Expand Up @@ -70,7 +71,7 @@ The following local inference options require `NEMOCLAW_EXPERIMENTAL=1` and, whe
| Option | Condition | Notes |
|--------|-----------|-------|
| Local NVIDIA NIM | NIM-capable GPU detected | Pulls and manages a NIM container. |
| Local vLLM | vLLM running on `localhost:8000` | Auto-detects the loaded model. |
| Local vLLM | vLLM running on `localhost:8000`, or a supported DGX Spark, DGX Station, or Linux NVIDIA GPU profile | Auto-detects the loaded model. Can install or start a managed vLLM container for supported profiles. |

For setup instructions, refer to Use a Local Inference Server (use the `nemoclaw-user-configure-inference` skill).

Expand Down
Loading
Loading