docs: refresh daily docs for 0.0.29 by miyoungc · Pull Request #2650 · NVIDIA/NemoClaw

miyoungc · 2026-04-29T00:46:09Z

Summary

Refreshes the 0.0.29 documentation for user-facing changes merged in the past 24 hours. Version metadata stays on 0.0.29.

Changes

docs/get-started/quickstart.md, docs/reference/commands.md, and docs/reference/troubleshooting.md: Document dashboard port auto-allocation, --control-ui-port, and nemoclaw list dashboard URL output from #2411.
docs/inference/inference-options.md and docs/inference/switch-inference-providers.md: Document local Ollama and local vLLM credential isolation from OPENAI_API_KEY from #2580.
docs/inference/inference-options.md: Document Local NVIDIA NIM validation behavior from #2505.
docs/reference/commands.md: Document the cloud-only NIM status display behavior from #2622.
docs/deployment/deploy-to-remote-gpu.md: Clarify runtime propagation for NEMOCLAW_PROXY_HOST and NEMOCLAW_PROXY_PORT from #2581.
docs/workspace/backup-restore.md: Document snapshot restore symlink handling for sandbox data paths from #2488.
docs/reference/commands.md: Document skill install --help and OpenClaw plugin-shaped directory guidance from #2585.

Type of Change

Code change (feature, bug fix, or refactor)
Code change with doc updates
Doc only (prose changes, no code sample modifications)
Doc only (includes code sample changes)

Verification

npx prek run --all-files passes
npm test passes
Tests added or updated for new or changed behavior
No secrets, API keys, or credentials committed
Docs updated for user-facing behavior changes
make docs builds without warnings (doc changes only)
Doc pages follow the style guide (doc changes only)
New doc pages include SPDX header and frontmatter (new pages only)

AI Disclosure

AI-assisted — tool: Codex

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

Documentation
- Added --control-ui-port flag for explicit dashboard port control
- Implemented automatic port selection (18789–18799) when the default port is occupied
- Clarified that local inference routes (Ollama, local vLLM) don't require OPENAI_API_KEY
- Improved dashboard URL display in list and status commands
- Enhanced symlink handling in workspace backup restoration
- Updated multi-sandbox quickstart and troubleshooting guidance

coderabbitai · 2026-04-29T00:46:21Z

📝 Walkthrough

Walkthrough

The documentation is updated to clarify dashboard port management behavior (auto-selection within 18789–18799 range and new --control-ui-port flag), confirm local inference providers don't require OPENAI_API_KEY, document proxy configuration propagation in runtime containers, and specify symlink handling during workspace restoration.

Changes

Cohort / File(s)	Summary
Dashboard Port Management `docs/get-started/quickstart.md`, `docs/reference/commands.md`, `docs/reference/troubleshooting.md`	Introduces `--control-ui-port` flag for explicit port selection, documents automatic port scanning (`18789`–`18799`) when default is occupied, and updates guidance to prefer flag over environment variable overrides.
Inference Provider Configuration `docs/inference/inference-options.md`, `docs/inference/switch-inference-providers.md`	Clarifies that local Ollama and vLLM routes use provider-specific local tokens rather than `OPENAI_API_KEY`, and that legacy sandbox rebuilds migrate away from stale OpenAI credential expectations.
Deployment and Workspace Management `docs/deployment/deploy-to-remote-gpu.md`, `docs/workspace/backup-restore.md`	Adds proxy configuration propagation behavior to runtime containers and specifies symlink acceptance rules for workspace restoration (accepts symlinks resolving to NemoClaw sandbox data directories).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Port numbers dance in harmony,
While tokens flow locally free,
New flags bloom, old paths realign,
Documentation refined, workflows divine!
NemoClaw grows clearer each day. ✨

🚥 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 'docs: refresh daily docs for 0.0.29' accurately describes the main change—a version refresh documentation update for 0.0.29. It is concise, clear, and directly reflects the primary objective of the PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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 docs/daily-refresh-0.0.29-20260428

_{Review rate limit: 9/10 reviews remaining, refill in 6 minutes.}

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

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

docs/reference/troubleshooting.md (1)
163-166: Optional readability polish: vary sentence openings in this block.
Three consecutive sentences start with “If,” which reads a bit repetitive in troubleshooting flow.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/troubleshooting.md` around lines 163 - 166, The three
consecutive sentences starting "If another sandbox already owns the dashboard
port...", "If all ports in that range are occupied...", and "If a non-NemoClaw
process is already bound..." read repetitively; rewrite them to vary sentence
openings while preserving meaning—e.g., keep the first as-is, change the second
to start with "When all ports in that range are occupied..." and change the
third to start with "To resolve a non-NemoClaw process binding the dashboard or
gateway port, identify the conflicting process, verify it is safe to stop, and
terminate it:" so the flow is less repetitive but the guidance about ports,
owners, and using --control-ui-port remains intact.
docs/workspace/backup-restore.md (1)
65-65: Use active voice.

"are still rejected" is passive voice. The style guide requires active voice throughout.

Suggested rewording:

"NemoClaw rejects symlinks that point outside the known sandbox data paths during extraction."

"The restore operation rejects symlinks that point outside the known sandbox data paths."

As per coding guidelines, "Active voice required. Flag passive constructions."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/workspace/backup-restore.md` at line 65, Replace the passive sentence
"Symlinks that point outside the known sandbox data paths are still rejected
during extraction." with an active-voice version; update the line in
docs/workspace/backup-restore.md (the sentence under the extraction behavior
section) to one of the suggested active forms such as "NemoClaw rejects symlinks
that point outside the known sandbox data paths during extraction." or "The
restore operation rejects symlinks that point outside the known sandbox data
paths." so the document follows the "Active voice required" guideline.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/workspace/backup-restore.md`:
- Line 64: Update the docs to list both NemoClaw-managed sandbox data paths
rather than only /sandbox/.openclaw-data/: explicitly mention
/sandbox/.openclaw-data/ and /sandbox/.hermes-data/ so the text matches the
implementation (see sandbox-state.ts validation and agent-defs.ts agent config
that accept both paths).

---

Nitpick comments:
In `@docs/reference/troubleshooting.md`:
- Around line 163-166: The three consecutive sentences starting "If another
sandbox already owns the dashboard port...", "If all ports in that range are
occupied...", and "If a non-NemoClaw process is already bound..." read
repetitively; rewrite them to vary sentence openings while preserving
meaning—e.g., keep the first as-is, change the second to start with "When all
ports in that range are occupied..." and change the third to start with "To
resolve a non-NemoClaw process binding the dashboard or gateway port, identify
the conflicting process, verify it is safe to stop, and terminate it:" so the
flow is less repetitive but the guidance about ports, owners, and using
--control-ui-port remains intact.

In `@docs/workspace/backup-restore.md`:
- Line 65: Replace the passive sentence "Symlinks that point outside the known
sandbox data paths are still rejected during extraction." with an active-voice
version; update the line in docs/workspace/backup-restore.md (the sentence under
the extraction behavior section) to one of the suggested active forms such as
"NemoClaw rejects symlinks that point outside the known sandbox data paths
during extraction." or "The restore operation rejects symlinks that point
outside the known sandbox data paths." so the document follows the "Active voice
required" guideline.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0296f456-4d81-40a6-80cc-c8bbb02ff99e

📥 Commits

Reviewing files that changed from the base of the PR and between a9c1559 and 57ba3ff.

📒 Files selected for processing (7)

docs/deployment/deploy-to-remote-gpu.md
docs/get-started/quickstart.md
docs/inference/inference-options.md
docs/inference/switch-inference-providers.md
docs/reference/commands.md
docs/reference/troubleshooting.md
docs/workspace/backup-restore.md

coderabbitai · 2026-04-29T00:50:23Z

 ```

 The `nemoclaw <name> rebuild` command uses the same snapshot mechanism automatically.
+Snapshot restore accepts symlinks that resolve to NemoClaw-managed sandbox data paths such as `/sandbox/.openclaw-data/`.


⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash # Search for user-facing references to .hermes-data to determine if it should be documented rg -n --type=md -C2 '\.hermes-data' docs/

Repository: NVIDIA/NemoClaw

Length of output: 41

🏁 Script executed:

# Search for .hermes-data in all files to understand its purpose and context rg -n '\.hermes-data' --type-list | head -20

Repository: NVIDIA/NemoClaw

Length of output: 449

🏁 Script executed:

# Find the sandbox-state.ts file and examine context around the SANDBOX_DATA_PREFIXES fd -name 'sandbox-state.ts' -o -name 'sandbox-state.js'

Repository: NVIDIA/NemoClaw

Length of output: 290

🏁 Script executed:

# Search for any comments or context around hermes-data in the codebase rg -n 'hermes' --type=ts --type=js -B2 -A2

Repository: NVIDIA/NemoClaw

Length of output: 20814

Mention both Hermes and OpenClaw sandbox data paths.

The documentation mentions only /sandbox/.openclaw-data/, but the implementation in src/lib/sandbox-state.ts (and agent configuration in src/lib/agent-defs.ts) supports both /sandbox/.openclaw-data/ and /sandbox/.hermes-data/ as valid NemoClaw-managed sandbox data paths. Since Hermes is a supported agent with its own data directory, both paths should be listed for completeness: /sandbox/.openclaw-data/ and /sandbox/.hermes-data/.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@docs/workspace/backup-restore.md` at line 64, Update the docs to list both NemoClaw-managed sandbox data paths rather than only /sandbox/.openclaw-data/: explicitly mention /sandbox/.openclaw-data/ and /sandbox/.hermes-data/ so the text matches the implementation (see sandbox-state.ts validation and agent-defs.ts agent config that accept both paths).

ericksoa

Reviewed the docs-only diff against the implementation. The dashboard port, local inference credential, proxy propagation, skill install, status/list, and snapshot restore guidance all match current behavior. Existing bot comments are minor wording/completeness nits and not blocking from my side.

## Summary Refreshes the 0.0.29 documentation for user-facing changes merged in the past 24 hours. Version metadata stays on `0.0.29`. ## Changes - `docs/get-started/quickstart.md`, `docs/reference/commands.md`, and `docs/reference/troubleshooting.md`: Document dashboard port auto-allocation, `--control-ui-port`, and `nemoclaw list` dashboard URL output from [NVIDIA#2411](NVIDIA#2411). - `docs/inference/inference-options.md` and `docs/inference/switch-inference-providers.md`: Document local Ollama and local vLLM credential isolation from `OPENAI_API_KEY` from [NVIDIA#2580](NVIDIA#2580). - `docs/inference/inference-options.md`: Document Local NVIDIA NIM validation behavior from [NVIDIA#2505](NVIDIA#2505). - `docs/reference/commands.md`: Document the cloud-only NIM status display behavior from [NVIDIA#2622](NVIDIA#2622). - `docs/deployment/deploy-to-remote-gpu.md`: Clarify runtime propagation for `NEMOCLAW_PROXY_HOST` and `NEMOCLAW_PROXY_PORT` from [NVIDIA#2581](NVIDIA#2581). - `docs/workspace/backup-restore.md`: Document snapshot restore symlink handling for sandbox data paths from [NVIDIA#2488](NVIDIA#2488). - `docs/reference/commands.md`: Document `skill install --help` and OpenClaw plugin-shaped directory guidance from [NVIDIA#2585](NVIDIA#2585). ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Verification - [x] `npx prek run --all-files` passes - [ ] `npm test` passes - [ ] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [x] Docs updated for user-facing behavior changes - [x] `make docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) ## AI Disclosure - [x] AI-assisted — tool: Codex --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>  ## Summary by CodeRabbit * **Documentation** * Added `--control-ui-port` flag for explicit dashboard port control * Implemented automatic port selection (18789–18799) when the default port is occupied * Clarified that local inference routes (Ollama, local vLLM) don't require `OPENAI_API_KEY` * Improved dashboard URL display in list and status commands * Enhanced symlink handling in workspace backup restoration * Updated multi-sandbox quickstart and troubleshooting guidance

docs: refresh daily docs for 0.0.29

57ba3ff

miyoungc added the documentation label Apr 29, 2026

miyoungc self-assigned this Apr 29, 2026

coderabbitai Bot reviewed Apr 29, 2026

View reviewed changes

ericksoa approved these changes Apr 29, 2026

View reviewed changes

miyoungc merged commit f86c405 into main Apr 29, 2026
22 checks passed

miyoungc deleted the docs/daily-refresh-0.0.29-20260428 branch May 27, 2026 20:51

wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: refresh daily docs for 0.0.29#2650

docs: refresh daily docs for 0.0.29#2650
miyoungc merged 1 commit into
mainfrom
docs/daily-refresh-0.0.29-20260428

miyoungc commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Apr 29, 2026

Uh oh!

ericksoa left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

miyoungc commented Apr 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Type of Change

Verification

AI Disclosure

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

ericksoa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

miyoungc commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading