Skip to content

docs: refresh 0.0.54 release docs#4539

Merged
miyoungc merged 3 commits into
mainfrom
docs/refresh-0.0.54
May 29, 2026
Merged

docs: refresh 0.0.54 release docs#4539
miyoungc merged 3 commits into
mainfrom
docs/refresh-0.0.54

Conversation

@miyoungc
Copy link
Copy Markdown
Collaborator

@miyoungc miyoungc commented May 29, 2026

Summary

Refreshes the NemoClaw documentation for the v0.0.54 release and regenerates user skills from the Fern MDX source. Also keeps the Fern CLI pin current so local docs checks use the upgraded Fern version.

Related Issue

Changes

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
  • npm run 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)

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

Summary by CodeRabbit

  • New Features

    • Optional NemoHermes native web dashboard (configurable port and TUI)
    • GPU memory cleanup now unloads Ollama models when switching providers or stopping services
  • Bug Fixes

    • Improved sandbox name validation with suggested slug recovery
    • Windows-host Ollama now requires Docker Desktop WSL integration and exits with remediation guidance when unsupported
  • Documentation

    • Clarified quickstart/onboard flow, installer TTY/non‑TTY guidance, Hermes Docker prerequisites, sandbox hardening, and channels add rebuild checks

Review Change Stack

@miyoungc miyoungc added documentation Improvements or additions to documentation v0.0.54 Release target labels May 29, 2026
@miyoungc miyoungc self-assigned this May 29, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

📝 Walkthrough

Walkthrough

This PR updates NemoClaw documentation across 16 files to reflect v0.0.54 changes: Windows/WSL Docker Desktop integration for Ollama, optional Hermes native web dashboard with new environment variables, clarified onboarding flow sequencing with web search/messaging before policy tier selection, GPU memory cleanup Ollama behavior, messaging channel bridge validation, sandbox filesystem security, Homebrew guidance, release notes, and a Fern config bump.

Changes

Core Windows/WSL, Ollama, and Hermes Feature Documentation

Layer / File(s) Summary
Windows WSL Docker integration and Ollama restrictions
.agents/skills/nemoclaw-user-configure-inference/SKILL.md, docs/inference/use-local-inference.mdx, .agents/skills/nemoclaw-user-get-started/references/windows-preparation.md, docs/get-started/windows-preparation.mdx
WSL-host Ollama now requires Docker Desktop WSL integration; when native Docker is detected, provider actions exit early with a remediation message instead of attempting install. Bootstrap script behavior updated to clarify handoff window, account wait, Docker Desktop WSL integration enabling, and conditional restart.
GPU memory cleanup and Ollama model unloading
.agents/skills/nemoclaw-user-configure-inference/references/use-local-inference-details.md, .agents/skills/nemoclaw-user-configure-inference/SKILL.md
New GPU Memory Cleanup subsection describes NemoClaw sending keep_alive: 0 on a best-effort basis to ask Ollama to unload models from GPU memory when switching providers or destroying sandboxes; model files are preserved. References consolidated to point to use-local-inference-details.
Hermes native web dashboard and remote API exposure
.agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md, .agents/skills/nemoclaw-user-reference/references/commands.md
Opt-in Hermes dashboard controlled by NEMOCLAW_HERMES_DASHBOARD, NEMOCLAW_HERMES_DASHBOARD_PORT, NEMOCLAW_HERMES_DASHBOARD_TUI. Remote API exposure guidance via CHAT_UI_URL (port 8642) and dashboard forwarding/access instructions (default port 9119).
Onboarding wizard flow and CLI input ordering
.agents/skills/nemoclaw-user-get-started/SKILL.md, .agents/skills/nemoclaw-user-get-started/references/quickstart-details.md, .agents/skills/nemoclaw-user-reference/references/commands.md, .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
Onboarding flow clarified: inference provider/model/credentials/sandbox-name are collected before policy-tier selection; web search and messaging prompts occur before policy-tier selection. Installer pipeline docs updated for non-interactive third-party acceptance. Sandbox name validation now emits Try: <suggested-slug> when applicable.
Messaging channels bridge validation and rebuild behavior
.agents/skills/nemoclaw-user-manage-sandboxes/references/messaging-channels.md, docs/manage-sandboxes/messaging-channels.mdx, .agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.mdx
channels add for Telegram, Discord, and Slack performs post-rebuild bridge startup verification and reports credential, startup, or missing-plugin warnings before returning.
Sandbox filesystem security and DAC constraints
.agents/skills/nemoclaw-user-deploy-remote/references/sandbox-hardening.md
/sandbox/.nemoclaw Filesystem Layout table expanded to clarify Landlock writability is constrained by POSIX DAC: sandbox user can write only to state/, migration/, snapshots/, staging/, config.json; blueprints/ and parent directories remain root-owned.
Homebrew integration, release notes, and configuration
.agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md, .agents/skills/nemoclaw-user-overview/references/release-notes.md, docs/about/release-notes.mdx, fern/fern.config.json, .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Homebrew guidance revised to describe /usr/local/bin/brew as a PATH wrapper and show exec usage (bash -lc). v0.0.54 release notes added to skill and public docs. Fern config version bumped from 5.35.4 to 5.41.2. Contributor skill guidance updated for release-note linking rules.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4296: Updates the same sandbox-hardening "Filesystem Layout" documentation for /sandbox/.nemoclaw to clarify Landlock writability constraints with DAC permissions.
  • NVIDIA/NemoClaw#4451: Overlaps on onboarding/CLI documentation for nemoclaw onboard (including --resume/--fresh flags) and wizard step ordering for web-search/messaging flow.
  • NVIDIA/NemoClaw#4078: Related updates to Windows-host Ollama guidance and early-exit remediation behavior in nemoclaw-user-configure-inference/SKILL.md.

Suggested reviewers

  • jyaunches
  • cv
  • ericksoa

Poem

🐰 Docs hop through WSL with Docker's grace,
Ollama's models rest in their rightful place,
Hermes dashboards glow on port nine-one-one-nine,
Onboarding flows align, prompts neatly in line,
Bridge warnings bloom—NemoClaw's tidy sign!

🚥 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 reflects the main objective of this pull request: refreshing documentation for the v0.0.54 release and regenerating user skills from Fern MDX source.
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/refresh-0.0.54

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

E2E Advisor Recommendation

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

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. No required E2E is recommended. The PR is limited to documentation, generated agent-skill markdown, release notes, and Fern docs configuration; it does not modify installer/onboarding code, sandbox lifecycle code, credential handling, security policy assets, inference routing implementation, deployment code, or executable user-flow logic. Existing docs PR checks should cover local link and command-reference parity concerns.

Optional E2E

  • docs-validation-e2e (low): Optional confidence check for documentation-only changes. It runs CLI/docs parity and markdown link validation, which is relevant to commands.mdx and generated skill/doc link integrity, but it is not required because no runtime code or sandbox behavior changed.

New E2E recommendations

  • None.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 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. Changes are limited to documentation, generated agent skill/reference documentation, and Fern docs configuration. No files under test/e2e-scenario/, scenario workflows, scenario metadata, expected-state contracts, suite metadata, runtime code, suite scripts, or onboarding/install helper code changed, so scenario E2E behavior is not affected.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

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: 4

🤖 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-deploy-remote/references/sandbox-hardening.md:
- Around line 88-94: The change was made directly in the autogenerated skill
markdown
`.agents/skills/nemoclaw-user-deploy-remote/references/sandbox-hardening.md`;
revert that edit and instead apply the modification to the canonical docs source
under the docs/ tree (the source page that generates the sandbox-hardening.md
content), then run the docs-to-skills regeneration pipeline so the updated text
flows into `.agents/skills/nemoclaw-user-*`; do not edit files under
`.agents/skills/nemoclaw-user-*` directly as per the guidelines.

In
@.agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md:
- Around line 264-266: This change edits an autogenerated skill markdown
(.agents/skills/nemoclaw-user-*/*.md) which must not be modified directly;
revert any edits to
".agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md"
and instead make the desired content change in the canonical docs source used to
generate these files, then run the docs/skill generation flow (the doc source ->
generation script) to regenerate the .agents/skills/nemoclaw-user-*/*.md outputs
and commit those generated changes; ensure the CI/regeneration step creates the
updated integration-policy-examples.md rather than editing it manually.

In @.agents/skills/nemoclaw-user-overview/references/release-notes.md:
- Around line 7-18: The release-notes.md under the autogenerated skill path
(.agents/skills/nemoclaw-user-overview/references/release-notes.md) was edited
by hand but must be regenerated from the skill generator; revert the manual
changes, restore the file to the generated state from the generator output, and
re-run the skill generation pipeline that produces nemoClaw user overview skills
(the generator responsible for .agents/skills/nemoclaw-user-*/*.md) so the file
is recreated correctly; if the generator source templates changed, update those
templates instead of editing this markdown directly and commit the regenerated
artifact.

In `@docs/reference/commands.mdx`:
- Line 705: The sentence in docs/reference/commands.mdx uses passive voice ("a
rebuild triggered by `channels add`"); rewrite it in active voice so the subject
performs the action, e.g., start the sentence with the command `channels add` as
the actor (for example: "`channels add` triggers a rebuild for Telegram,
Discord, and Slack that also verifies the selected bridge and reports
credential, startup, or plugin discovery warnings"), ensuring you reference the
`channels add` command and preserve the original checks (selected bridge
verification and credential/startup/plugin discovery warnings) and phrasing
consistent with docs/manage-sandboxes/messaging-channels.mdx.
🪄 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: 3a348c05-cc45-4bdc-be5f-b0057ba3db0a

📥 Commits

Reviewing files that changed from the base of the PR and between 9b13f89 and a724a8c.

📒 Files selected for processing (18)
  • .agents/skills/nemoclaw-user-configure-inference/SKILL.md
  • .agents/skills/nemoclaw-user-configure-inference/references/use-local-inference-details.md
  • .agents/skills/nemoclaw-user-deploy-remote/references/sandbox-hardening.md
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • .agents/skills/nemoclaw-user-get-started/references/quickstart-details.md
  • .agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md
  • .agents/skills/nemoclaw-user-get-started/references/windows-preparation.md
  • .agents/skills/nemoclaw-user-manage-policy/references/integration-policy-examples.md
  • .agents/skills/nemoclaw-user-manage-sandboxes/references/messaging-channels.md
  • .agents/skills/nemoclaw-user-overview/references/release-notes.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/windows-preparation.mdx
  • docs/inference/use-local-inference.mdx
  • docs/manage-sandboxes/messaging-channels.mdx
  • docs/reference/commands.mdx
  • fern/fern.config.json

Comment thread .agents/skills/nemoclaw-user-overview/references/release-notes.md
Comment thread docs/reference/commands.mdx
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: 1

🤖 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-contributor-update-docs/SKILL.md:
- Line 137: The release-note bullet in SKILL.md uses a placeholder link
`/doc/path` which breaks link checks; update the line "For more information,
refer to [DOC PAGE](/doc/path)." to use a real doc path (for example the v0.0.54
release page) such as "For more information, refer to [Release
v0.0.54](/docs/releases/v0.0.54)." or, if you must keep an example, escape it so
the link checker ignores it; locate that exact sentence in SKILL.md and replace
the placeholder link accordingly.
🪄 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: 28a4a241-d8b0-40a3-895d-b5159b0b6acd

📥 Commits

Reviewing files that changed from the base of the PR and between a724a8c and 747d08e.

📒 Files selected for processing (3)
  • .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
  • .agents/skills/nemoclaw-user-overview/references/release-notes.md
  • docs/about/release-notes.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/about/release-notes.mdx
  • .agents/skills/nemoclaw-user-overview/references/release-notes.md


**Release prep only:** When updating `docs/about/release-notes.mdx`:

- For each release-note bullet that corresponds to a deeper doc page, end the bullet with `For more information, refer to [DOC PAGE](/doc/path).`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Replace the placeholder path with a concrete example to fix the broken link.

The placeholder /doc/path is causing the link checker to fail. Use a real example from the release notes instead to demonstrate the pattern and fix the pipeline failure.

🔧 Proposed fix using a concrete example from v0.0.54 release notes
-- For each release-note bullet that corresponds to a deeper doc page, end the bullet with `For more information, refer to [DOC PAGE](/doc/path).`
+- For each release-note bullet that corresponds to a deeper doc page, end the bullet with `For more information, refer to [DOC PAGE](/doc/path).` For example: `For more information, refer to [Messaging Channels](/manage-sandboxes/messaging-channels).`

Alternatively, escape the example so the link checker ignores it:

-- For each release-note bullet that corresponds to a deeper doc page, end the bullet with `For more information, refer to [DOC PAGE](/doc/path).`
+- For each release-note bullet that corresponds to a deeper doc page, end the bullet with: `For more information, refer to [DOC PAGE](/doc/path).`
🧰 Tools
🪛 GitHub Actions: Docs / Link Check / 0_markdown-links.txt

[error] 137-137: check-docs.sh (links) failed: broken site route in .agents/skills/nemoclaw-contributor-update-docs/SKILL.md:137 -> /doc/path

🪛 GitHub Actions: Docs / Link Check / markdown-links

[error] 137-137: check-docs.sh (links) failed: broken site route/target link in .agents/skills/nemoclaw-contributor-update-docs/SKILL.md:137 -> /doc/path

🤖 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-contributor-update-docs/SKILL.md at line 137, The
release-note bullet in SKILL.md uses a placeholder link `/doc/path` which breaks
link checks; update the line "For more information, refer to [DOC
PAGE](/doc/path)." to use a real doc path (for example the v0.0.54 release page)
such as "For more information, refer to [Release
v0.0.54](/docs/releases/v0.0.54)." or, if you must keep an example, escape it so
the link checker ignores it; locate that exact sentence in SKILL.md and replace
the placeholder link accordingly.

@github-actions
Copy link
Copy Markdown
Contributor

PR Review Advisor

Findings: 1 needs attention, 1 worth checking, 0 nice ideas
Since last review: 0 prior items resolved, 0 still apply, 1 new item found

Review findings

🛠️ Needs attention

  • Release-note link does not explain the security-sensitive behavior (docs/about/release-notes.mdx:24): The new release-prep guidance says release-note bullets should link to the most specific existing page that explains the behavior, command, setup flow, or troubleshooting path, and should not link when the only target is unrelated or too broad. This bullet links the narrowed OpenClaw `web_fetch` host-gateway allowance and Hermes Provider OAuth-vs-API-key smoke-check behavior to `/inference/inference-options`, but that page only lists provider options and does not explain host-gateway `web_fetch`, the trusted proxy path, strict/direct host-gateway blocking, OAuth-backed smoke-probe skipping, or direct Nous API-key validation. Because this is a network-policy and SSRF-sensitive topic, the broad link can give readers a false sense that the deeper docs contain the relevant security detail.
    • Recommendation: Either add the missing explanation to `docs/inference/inference-options.mdx` and keep the link, or split/remove the link so each release-note claim points only to a page that actually explains that behavior.
    • Evidence: `docs/about/release-notes.mdx:24` ends with `For more information, refer to [NemoClaw Inference Options](/inference/inference-options)`. The added guidance in `.agents/skills/nemoclaw-contributor-update-docs/SKILL.md:137-139` requires the linked page to explain the behavior and says not to add unrelated or overly broad links. Reading `docs/inference/inference-options.mdx` showed Hermes Provider and compatible endpoint summaries, but no host-gateway `web_fetch` or OAuth smoke-check detail.

🔎 Worth checking

  • Source-of-truth review needed: Release-note deep link for host-gateway `web_fetch` and Hermes Provider smoke-check behavior: The advisor marked localized patch analysis as needs_followup.
    • Recommendation: Identify the invalid state, source boundary, source-fix constraint, regression test, and removal condition before merging the localized behavior.
    • Evidence: `docs/about/release-notes.mdx:24` links to `/inference/inference-options`; reading that page found provider summaries but not the host-gateway `web_fetch` or OAuth smoke-check details.

🌱 Nice ideas

  • None.
Since last review details

Current findings:

  • Source-of-truth review needed: Release-note deep link for host-gateway `web_fetch` and Hermes Provider smoke-check behavior: The advisor marked localized patch analysis as needs_followup.
    • Recommendation: Identify the invalid state, source boundary, source-fix constraint, regression test, and removal condition before merging the localized behavior.
    • Evidence: `docs/about/release-notes.mdx:24` links to `/inference/inference-options`; reading that page found provider summaries but not the host-gateway `web_fetch` or OAuth smoke-check details.
  • Release-note link does not explain the security-sensitive behavior (docs/about/release-notes.mdx:24): The new release-prep guidance says release-note bullets should link to the most specific existing page that explains the behavior, command, setup flow, or troubleshooting path, and should not link when the only target is unrelated or too broad. This bullet links the narrowed OpenClaw `web_fetch` host-gateway allowance and Hermes Provider OAuth-vs-API-key smoke-check behavior to `/inference/inference-options`, but that page only lists provider options and does not explain host-gateway `web_fetch`, the trusted proxy path, strict/direct host-gateway blocking, OAuth-backed smoke-probe skipping, or direct Nous API-key validation. Because this is a network-policy and SSRF-sensitive topic, the broad link can give readers a false sense that the deeper docs contain the relevant security detail.
    • Recommendation: Either add the missing explanation to `docs/inference/inference-options.mdx` and keep the link, or split/remove the link so each release-note claim points only to a page that actually explains that behavior.
    • Evidence: `docs/about/release-notes.mdx:24` ends with `For more information, refer to [NemoClaw Inference Options](/inference/inference-options)`. The added guidance in `.agents/skills/nemoclaw-contributor-update-docs/SKILL.md:137-139` requires the linked page to explain the behavior and says not to add unrelated or overly broad links. Reading `docs/inference/inference-options.mdx` showed Hermes Provider and compatible endpoint summaries, but no host-gateway `web_fetch` or OAuth smoke-check detail.

Workflow run details

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

@miyoungc miyoungc merged commit 6fb96bd into main May 29, 2026
30 of 31 checks passed
@miyoungc miyoungc deleted the docs/refresh-0.0.54 branch May 29, 2026 18:03
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.54 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants