Skip to content

docs(release): refresh 0.0.41 documentation#3531

Merged
cv merged 1 commit into
mainfrom
docs-0.0.41-release
May 14, 2026
Merged

docs(release): refresh 0.0.41 documentation#3531
cv merged 1 commit into
mainfrom
docs-0.0.41-release

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented May 14, 2026

Summary

  • Bump the docs metadata and version switcher to 0.0.41.
  • Add v0.0.41 release notes plus operator guidance for OpenShell pinning, Docker bridge reachability, Local Ollama proxy reachability, and Docker GPU onboarding diagnostics.
  • Refresh generated nemoclaw-user-* skills from the updated docs.

Source summary

Test plan

  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user
  • make docs
  • git diff --check
  • npm run build:cli
  • npm run typecheck:cli
  • pre-commit hooks during git commit

Summary by CodeRabbit

  • New Features

    • Added nemoclaw inference get command to check current inference settings
    • Improved gateway health validation with Linux firewall remediation guidance
  • Bug Fixes

    • Enhanced proxy readiness validation with sandbox network path probes
    • Improved local Ollama route onboarding with rerun-safe fixes
    • Better sandbox-to-gateway connectivity detection
  • Documentation

    • Expanded troubleshooting guidance for firewall and connectivity issues
    • Updated CLI reference with new command and environment variable documentation
    • Added gateway binding and Docker-driver GPU compatibility guidance

Review Change Stack

@miyoungc miyoungc added documentation Improvements or additions to documentation v0.0.41 Release target labels May 14, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 73928d0b-88fc-4d56-9d41-a59fb314340c

📥 Commits

Reviewing files that changed from the base of the PR and between 25a9ee9 and 85733f7.

📒 Files selected for processing (15)
  • .agents/skills/nemoclaw-user-configure-inference/SKILL.md
  • .agents/skills/nemoclaw-user-configure-inference/references/inference-options.md
  • .agents/skills/nemoclaw-user-configure-security/references/best-practices.md
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
  • .agents/skills/nemoclaw-user-overview/references/release-notes.md
  • .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/about/release-notes.md
  • docs/inference/use-local-inference.md
  • docs/project.json
  • docs/reference/commands.md
  • docs/reference/troubleshooting.md
  • docs/versions1.json

📝 Walkthrough

Walkthrough

This PR updates NemoClaw documentation for the v0.0.41 release. Changes include a new sandbox Docker network proxy reachability probe with Linux firewall remediation, nemoclaw inference get and nemoclaw status command documentation, gateway bind address security guidance, Linux Docker-driver GPU compatibility and failure diagnostics, and comprehensive release notes across agent skills and public docs.

Changes

NemoClaw v0.0.41 Release Documentation

Layer / File(s) Summary
Proxy readiness probing and Linux firewall remediation
.agents/skills/nemoclaw-user-configure-inference/SKILL.md, docs/inference/use-local-inference.md, .agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md, docs/reference/troubleshooting.md
NemoClaw now probes the sandbox Docker network path to a reverse proxy before saving inference routes. When the probe fails with a TCP error, onboarding exits with a ufw allow command to remediate firewall blocks. When the probe cannot run (Docker Desktop/WSL routing differences), onboarding continues with the regular proxy health check.
Inference management commands and post-install guidance
.agents/skills/nemoclaw-user-get-started/SKILL.md, .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md, .agents/skills/nemoclaw-user-reference/references/commands.md
New nemoclaw inference get command documented to inspect live inference routes. Updated nemoclaw status to print gateway: down [state] (reason) with recovery guidance when gateway is unreachable. Post-install snippet added showing how to view and update inference settings via nemoclaw inference get and nemoclaw inference set.
Gateway binding, port, and environment variable configuration
.agents/skills/nemoclaw-user-configure-security/references/best-practices.md, .agents/skills/nemoclaw-user-reference/references/commands.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
Documentation of loopback-only default binding for OpenShell gateway via NEMOCLAW_GATEWAY_BIND_ADDRESS (default 127.0.0.1). Clarified security risks and remediation for port conflicts using NEMOCLAW_GATEWAY_PORT. Updated scripted OpenShell upgrade to install current supported release instead of pinned version.
Linux Docker-driver GPU compatibility and failure diagnostics
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md, docs/reference/troubleshooting.md
New Linux Docker-driver compatibility path where onboarding creates sandbox then recreates OpenShell container with NVIDIA GPU access. On patch failure, diagnostics are preserved and cleanup command is printed instead of auto-deleting. NEMOCLAW_DOCKER_GPU_PATCH=0 escape hatch provided for troubleshooting.
v0.0.41 release notes and version metadata
.agents/skills/nemoclaw-user-overview/references/release-notes.md, docs/about/release-notes.md, docs/project.json, docs/versions1.json
Release notes entry documenting onboarding improvements (release pinning with fallback, gateway health checks, firewall remediation, GPU diagnostics). Package version bumped from 0.0.40 to 0.0.41 and marked preferred in version manifest.
Supporting documentation clarifications and CLI updates
.agents/skills/nemoclaw-user-configure-inference/references/inference-options.md, .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md, .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
Local vLLM provider now requires NEMOCLAW_EXPERIMENTAL=1 in addition to server on localhost:8000. CLI selection guide removes openshell inference get -g nemoclaw example and emphasizes NemoClaw commands for model/provider changes. Uninstall flag description changed from openshell "binary" to OpenShell "binaries".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#3427: Proxy health-check and token-readiness documentation updates to Authenticated Reverse Proxy onboarding.
  • NVIDIA/NemoClaw#2823: Ollama reverse-proxy health behavior adjustments (bearer token, status code handling) related to proxy readiness logic.
  • NVIDIA/NemoClaw#3472: Sandbox-side Ollama proxy reachability probe and failure handling with TCP-failed firewall remediation guidance.

Suggested reviewers

  • cv
  • ericksoa

🐰 A release hops to life with careful care—
New proxy probes skip through the air,
GPU paths and gateways aligned,
Firewall rules kindly designed,
v0.0.41 bounds ahead without a care!

🚥 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(release): refresh 0.0.41 documentation' clearly and concisely summarizes the main change: updating documentation for release version 0.0.41. It follows conventional commit format and accurately reflects the primary purpose of the changeset.
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-0.0.41-release

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


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

@github-actions
Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: docs-validation-e2e

Dispatch hint: docs-validation-e2e

Workflow run

Full advisor summary

Pi Semantic E2E Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. PR is documentation-only (Sphinx docs and agent skill markdown). No source code, install scripts, workflows, blueprints, manifests, or test code is touched, so no runtime user flow, security boundary, networking, credential handling, sandbox lifecycle, inference routing, or deployment behavior can regress from these changes. Existing PR-time checks (docs-links-pr.yaml, docs-preview-pr.yaml, docs-cli-parity-pr.yaml) auto-trigger on the changed paths and provide sufficient guardrails; full E2E is not merge-blocking.

Optional E2E

  • docs-validation-e2e (low): Existing nightly job runs test/e2e/test-docs-validation.sh, which exercises CLI/docs parity (nemoclaw --help vs commands.md) and markdown link validation. The PR adds newly documented commands/env vars; running this gives confidence that documentation matches the actual installed CLI surface. Note that docs-cli-parity-pr.yaml and docs-links-pr.yaml auto-trigger on these paths and provide overlapping PR-time coverage.

New E2E recommendations

  • None.

Dispatch hint

  • Workflow: nightly-e2e.yaml
  • jobs input: docs-validation-e2e

@jyaunches jyaunches self-requested a review May 14, 2026 16:41
@github-actions
Copy link
Copy Markdown
Contributor

Selective E2E Results — ✅ All requested jobs passed

Run: 25873115292
Target ref: 85733f7999b630a88ee21cda482ccba1631d45ed
Workflow ref: main
Requested jobs: docs-validation-e2e
Summary: 1 passed, 0 failed, 0 skipped

Job Result
docs-validation-e2e ✅ success

@cv cv added v0.0.42 Release target and removed v0.0.41 Release target labels May 14, 2026
@cv cv merged commit e0a926d into main May 14, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v0.0.42 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants