Skip to content

docs: refresh 0.0.58 release docs and refresh skills#4743

Merged
cv merged 3 commits into
mainfrom
docs/0.0.58-release-docs
Jun 4, 2026
Merged

docs: refresh 0.0.58 release docs and refresh skills#4743
cv merged 3 commits into
mainfrom
docs/0.0.58-release-docs

Conversation

@miyoungc
Copy link
Copy Markdown
Collaborator

@miyoungc miyoungc commented Jun 4, 2026

Summary

  • Add v0.0.58 release notes for GPU proof reporting, local inference metadata, policy safety, diagnostics, installer preflight, and Hermes reliability fixes.
  • Update source docs for the new binutils prerequisite, CUDA proof status output, policy-add safety behavior, and vLLM runtime context-window metadata.
  • Refresh generated NemoClaw user skills from the updated Fern MDX source pages.

Source summary

Verification

  • npm run docs:sync-agent-variants
  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx
  • npm run docs
  • Commit hooks: markdownlint, docs-to-skills verification, gitleaks, env-var documentation gate, and skills YAML checks passed.

Note: this repository does not currently have a literal documentation label; this PR uses area: docs plus v0.0.58.

Summary by CodeRabbit

  • Documentation
    • Unified CLI guidance to use nemoclaw across docs for simpler, consistent commands.
    • Added CUDA usability proof reporting and remediation guidance in sandbox status.
    • Documented OpenClaw OTEL diagnostics export via diagnostics-otel preset.
    • Added installer prerequisite check for strings (binutils) with troubleshooting steps.
    • Clarified credential storage, environment-variable precedence, policy error handling/recovery, sandbox hardening and capability-drop fail-closed option.
    • Noted local vLLM metadata usage for context-window sizing.

Document the 0.0.58 release-facing behavior changes.
Refresh generated user skills for release prep.
@miyoungc miyoungc added v0.0.58 Release target area: docs Documentation, examples, guides, or docs build labels Jun 4, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

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: 41104ed2-1239-499d-a23b-8173f9e1edee

📥 Commits

Reviewing files that changed from the base of the PR and between d5cf071 and 2c71efd.

📒 Files selected for processing (1)
  • docs/reference/commands.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/reference/commands.mdx

📝 Walkthrough

Walkthrough

This PR standardizes CLI examples to nemoclaw across skills and docs, consolidates variant-specific AgentOnly blocks, clarifies security and runtime behaviors (capability drops, GPU proof states), adds OpenClaw OTEL diagnostics docs, and inserts v0.0.58 release notes.

Changes

NemoClaw Documentation Consolidation and Feature Notes

Layer / File(s) Summary
Inference onboarding and provider switching
.agents/skills/nemoclaw-user-configure-inference/*, docs/inference/*
Replaces AgentOnly-scoped nemohermes variants with unified nemoclaw commands in fenced bash blocks for onboarding, OpenAI/Anthropic/vLLM/NIM setup, non-interactive provider configuration, runtime model switching, and timeout handling; documents vLLM max_model_len usage.
Security, policy, and credential standardization
.agents/skills/nemoclaw-user-configure-security/references/*, .agents/skills/nemoclaw-user-manage-policy/*
Adds SSRF/egress and capability-drop clarifications (including NEMOCLAW_REQUIRE_CAP_DROP=1), removes AgentOnly branching in credential and policy docs, and consolidates preset-management examples to nemoclaw commands.
Sandbox lifecycle, channels, and runtime controls
.agents/skills/nemoclaw-user-manage-sandboxes/*
Unifies CLI commands for sandbox listing, status/health, diagnostics, onboard/rebuild/recover, snapshots, messaging channels, tunnels, and runtime controls to nemoclaw forms; removes nemohermes variant examples.
Monitoring, session inspection, and CLI selection
.agents/skills/nemoclaw-user-monitor-sandbox/SKILL.md, .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md, .agents/skills/nemoclaw-user-overview/references/*
Standardizes status/logs to nemoclaw, adds host-side session-state inspection paths and host commands, recommends nemoclaw <name> exec for managed one-off commands, and updates navigation/troubleshooting links.
Installer prerequisites and release notes
.agents/skills/nemoclaw-user-get-started/references/prerequisites.md, docs/about/release-notes.mdx, .agents/skills/nemoclaw-user-overview/references/release-notes.md
Adds binutils/strings installer prerequisite and troubleshooting snippet; inserts v0.0.58 release-notes entries.
Commands reference behavioral updates
.agents/skills/nemoclaw-user-reference/references/commands*.md, docs/reference/commands*.mdx
Documents GPU passthrough CUDA-proof reporting (verified/unverified/failed + remediation), safer policy-add pre-merge validation behavior, and OpenClaw OTEL diagnostics env vars, preset timing, and local Jaeger guidance.

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4166: Overlaps with docs/reference/commands.mdx Remote Deployment env var additions documented here.
  • NVIDIA/NemoClaw#4717: Related to inference provider switching and rebuild/recovery guidance referenced in these docs.
  • NVIDIA/NemoClaw#4707: Implements capability-drop enforcement logic that this PR documents (NEMOCLAW_REQUIRE_CAP_DROP=1).

Suggested labels

documentation, v0.0.58

Suggested reviewers

  • cv

"🐰
I hopped through lines to make docs one,
Replaced the variants till the work was done.
nemoclaw now sings where splits once played,
With proofs and OTEL neatly displayed.
Docs aligned, the rabbit's work is spun."

🚥 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 accurately summarizes the main changes: documentation refresh for v0.0.58 release notes and regenerated user skills with updates to commands, references, and prerequisites.
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.58-release-docs

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

@miyoungc miyoungc added v0.0.59 Release target and removed v0.0.58 Release target labels Jun 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

PR Review Advisor

Findings: 0 needs attention, 1 worth checking, 0 nice ideas
Top item: PR review advisor unavailable

Review findings

🛠️ Needs attention

  • None.

🔎 Worth checking

  • PR review advisor unavailable: The automated advisor could not complete: Could not parse JSON from PR review advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/pr-review-advisor/pr-review-advisor-raw-output.txt
    • Recommendation: Re-run the PR Review Advisor or perform a manual review.
    • Evidence: Could not parse JSON from PR review advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/pr-review-advisor/pr-review-advisor-raw-output.txt

🌱 Nice ideas

  • None.

Workflow run details

This is an automated advisory review. A human maintainer must make the final merge decision.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. No E2E is recommended because this PR is documentation and agent-skill reference content only. The changes mention sensitive domains such as inference, credentials, policy, sandbox hardening, and deployment, but they do not modify runtime code, installer/onboarding logic, OpenShell integration, shipped policies, Dockerfiles, workflows, or scenario assets. Standard docs/MDX/link/CLI-reference checks are appropriate, but existing NemoClaw E2E jobs would not exercise these text-only edits in a merge-blocking way.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

  • None. Only documentation and agent skill/reference markdown files changed; no files under test/e2e-scenario/, scenario workflows, or other scenario E2E runtime/catalog surfaces were modified.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@miyoungc miyoungc changed the title docs: refresh 0.0.58 release docs docs: refresh 0.0.58 release docs and refresh skills Jun 4, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (3)
.agents/skills/nemoclaw-user-reference/references/commands-nemohermes.md (1)

1601-1601: ⚡ Quick win

Split this into one sentence per source line.

Line 1601 contains multiple sentences on a single line, which hurts diff readability.

As per coding guidelines, "One sentence per line in source (makes diffs readable)."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/nemoclaw-user-reference/references/commands-nemohermes.md at
line 1601, The sentence on the same line mixes multiple statements; split it
into separate lines so each sentence is on its own line. Specifically, break the
paragraph that mentions the preset openclaw-diagnostics-otel-local, the
condition NEMOCLAW_OPENCLAW_OTEL=1, and the guidance about enabling OTEL after
sandbox creation into one sentence per line (one sentence stating onboarding
applies the openclaw-diagnostics-otel-local preset at sandbox create and again
during the policy step when NEMOCLAW_OPENCLAW_OTEL=1; one sentence stating OTLP
export is allowed before the gateway's first trace flush; one sentence
instructing to run nemohermes <sandbox-name> policy-add
openclaw-diagnostics-otel-local --yes or recreate the sandbox with OTEL enabled
at build time if OTEL was enabled after creation).
.agents/skills/nemoclaw-user-reference/references/commands.md (1)

1872-1872: ⚡ Quick win

Split this into one sentence per source line.

Line 1872 contains multiple sentences on a single line, which hurts diff readability and violates the docs formatting rule.

As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/nemoclaw-user-reference/references/commands.md at line 1872,
Split the long line into separate source lines so each sentence stands alone:
break the line mentioning the preset `openclaw-diagnostics-otel-local`, the
condition `NEMOCLAW_OPENCLAW_OTEL=1`, the note about OTLP export/gateway flush,
and the instructions to run `nemoclaw <sandbox-name> policy-add
openclaw-diagnostics-otel-local --yes` or recreate the sandbox into individual
sentences on their own lines, preserving backticks and punctuation.
docs/about/release-notes.mdx (1)

20-24: ⚡ Quick win

Use one sentence per source line in these bullets.

Each changed bullet currently includes multiple sentences on the same line; split sentence boundaries into separate lines to match docs formatting rules.

As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/about/release-notes.mdx` around lines 20 - 24, The release-notes bullet
lines each contain multiple sentences on the same source line; update each
bullet so every sentence is on its own line (e.g., split the line starting with
"GPU and local-inference setup report more accurate state." into separate lines
for each sentence, do the same for the bullets beginning "Onboarding and
installer failures stop earlier...", "Policy and sandbox hardening paths avoid
misleading success.", "OpenClaw runtime diagnostics can export conversation
traces...", and "Hermes sandboxes are more reliable..."), ensuring one sentence
per source line to comply with the "one sentence per line" docs rule.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
@.agents/skills/nemoclaw-user-manage-sandboxes/references/runtime-controls.md:
- Line 81: The bullet contains a duplicated command name: "every `nemoclaw` and
`nemoclaw` command"; remove the duplicate and make the phrase unambiguous (e.g.,
"every `nemoclaw` command") or replace the second occurrence with the correct
command if a different tool was intended; update the sentence that references
the `nemoclaw-user-reference` skill so it clearly lists the distinct commands
and the environment variables that affect runtime behavior.

In @.agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md:
- Line 25: Fix the duplicated CLI name in the sentence on line 25 of SKILL.md:
replace the repeated "`nemoclaw`" with the intended "`nemoclaw-user-reference`"
so the sentence reads that the boundary is between `nemoclaw`,
`nemoclaw-user-reference`, and `openshell` (reference the mentioned
`nemoclaw-user-reference` skill and the existing `nemoclaw`/`openshell` CLI
names to locate the text to update).

In @.agents/skills/nemoclaw-user-overview/references/release-notes.md:
- Around line 9-19: The file
.agents/skills/nemoclaw-user-overview/references/release-notes.md is an
autogenerated skill doc and must not be edited directly; revert any direct edits
here and instead update the canonical source documentation (the release-notes
source used to generate the NemoClaw user skills), then run the skill generation
pipeline to regenerate the skill outputs (so the changes propagate into the
generated release-notes.md); ensure you locate the original source file that
feeds the generator (the release notes source for the NemoClaw user docs) and
apply the content changes there rather than modifying the generated
.agents/skills/*/*.md file.

---

Nitpick comments:
In @.agents/skills/nemoclaw-user-reference/references/commands-nemohermes.md:
- Line 1601: The sentence on the same line mixes multiple statements; split it
into separate lines so each sentence is on its own line. Specifically, break the
paragraph that mentions the preset openclaw-diagnostics-otel-local, the
condition NEMOCLAW_OPENCLAW_OTEL=1, and the guidance about enabling OTEL after
sandbox creation into one sentence per line (one sentence stating onboarding
applies the openclaw-diagnostics-otel-local preset at sandbox create and again
during the policy step when NEMOCLAW_OPENCLAW_OTEL=1; one sentence stating OTLP
export is allowed before the gateway's first trace flush; one sentence
instructing to run nemohermes <sandbox-name> policy-add
openclaw-diagnostics-otel-local --yes or recreate the sandbox with OTEL enabled
at build time if OTEL was enabled after creation).

In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 1872: Split the long line into separate source lines so each sentence
stands alone: break the line mentioning the preset
`openclaw-diagnostics-otel-local`, the condition `NEMOCLAW_OPENCLAW_OTEL=1`, the
note about OTLP export/gateway flush, and the instructions to run `nemoclaw
<sandbox-name> policy-add openclaw-diagnostics-otel-local --yes` or recreate the
sandbox into individual sentences on their own lines, preserving backticks and
punctuation.

In `@docs/about/release-notes.mdx`:
- Around line 20-24: The release-notes bullet lines each contain multiple
sentences on the same source line; update each bullet so every sentence is on
its own line (e.g., split the line starting with "GPU and local-inference setup
report more accurate state." into separate lines for each sentence, do the same
for the bullets beginning "Onboarding and installer failures stop earlier...",
"Policy and sandbox hardening paths avoid misleading success.", "OpenClaw
runtime diagnostics can export conversation traces...", and "Hermes sandboxes
are more reliable..."), ensuring one sentence per source line to comply with the
"one sentence per line" docs rule.
🪄 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: a212a42a-12a2-449f-b023-755cd1035a45

📥 Commits

Reviewing files that changed from the base of the PR and between 81a0e55 and d5cf071.

📒 Files selected for processing (30)
  • .agents/skills/nemoclaw-user-configure-inference/SKILL.md
  • .agents/skills/nemoclaw-user-configure-inference/references/inference-options.md
  • .agents/skills/nemoclaw-user-configure-inference/references/switch-inference-providers.md
  • .agents/skills/nemoclaw-user-configure-security/references/best-practices.md
  • .agents/skills/nemoclaw-user-configure-security/references/credential-storage.md
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-deploy-remote/references/sandbox-hardening.md
  • .agents/skills/nemoclaw-user-get-started/references/prerequisites.md
  • .agents/skills/nemoclaw-user-manage-policy/SKILL.md
  • .agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/backup-restore.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/messaging-channels.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/runtime-controls.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/workspace-files.md
  • .agents/skills/nemoclaw-user-monitor-sandbox/SKILL.md
  • .agents/skills/nemoclaw-user-overview/references/how-it-works.md
  • .agents/skills/nemoclaw-user-overview/references/overview.md
  • .agents/skills/nemoclaw-user-overview/references/release-notes.md
  • .agents/skills/nemoclaw-user-reference/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/cli-selection-guide.md
  • .agents/skills/nemoclaw-user-reference/references/commands-nemohermes.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/about/release-notes.mdx
  • docs/get-started/prerequisites.mdx
  • docs/inference/switch-inference-providers.mdx
  • docs/inference/use-local-inference.mdx
  • docs/reference/commands-nemohermes.mdx
  • docs/reference/commands.mdx
💤 Files with no reviewable changes (2)
  • .agents/skills/nemoclaw-user-configure-security/references/credential-storage.md
  • .agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md

Comment thread .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
Comment thread .agents/skills/nemoclaw-user-overview/references/release-notes.md
@cv cv enabled auto-merge (squash) June 4, 2026 02:19
@cv cv merged commit 17734b1 into main Jun 4, 2026
30 of 31 checks passed
@cv cv deleted the docs/0.0.58-release-docs branch June 4, 2026 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build v0.0.59 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants