docs: refresh v0.0.64 release docs#5358
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughDocumentation-only PR adding v0.0.64 release notes and multiple docs updates: snapshot/preset persistence, sub-agent Docker exec patterns, remote onboarding/deploy restructuring, new CLI host subcommands and session/file export docs, troubleshooting recovery changes, community links, and a docs-only CI from-ref tweak. ChangesNemoClaw v0.0.64 Documentation Release
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-5358.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Vitest E2E Scenario RecommendationRequired Vitest E2E scenarios: None Full Vitest E2E advisor summaryVitest E2E Scenario AdvisorBase: Required Vitest E2E scenarios
Optional Vitest E2E scenarios
Relevant changed files
|
PR Review AdvisorFindings: 2 needs attention, 9 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Consider writing more tests for
Since last review detailsCurrent findings:
This is an automated advisory review. A human maintainer must make the final merge decision. |
There was a problem hiding this comment.
🧹 Nitpick comments (5)
docs/about/release-notes.mdx (4)
22-22: ⚡ Quick winSplit sentences onto separate lines and use active voice.
This line violates the style guide in two ways:
- Multiple sentences on one line (the main statement ends at "sandbox." and then "For more information..." starts). The guide requires one sentence per line for diff readability.
- Passive voice: "presets applied with" should use active voice. Since the commands are
policy-add, use "presets you add with" to match the command name and maintain active voice.📝 Suggested rewrite
-- Snapshot restore preserves custom policy presets applied with `policy-add --from-file` or `policy-add --from-dir`, so restored sandboxes keep the custom egress rules that were recorded with the source sandbox. For more information, refer to [Backup and Restore](../manage-sandboxes/backup-restore) and [Customize the Network Policy](../network-policy/customize-network-policy). +- Snapshot restore preserves custom policy presets you add with `policy-add --from-file` or `policy-add --from-dir`, so restored sandboxes keep the custom egress rules that were recorded with the source sandbox. +For more information, refer to [Backup and Restore](../manage-sandboxes/backup-restore) and [Customize the Network Policy](../network-policy/customize-network-policy).As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line." and "Active voice required. Flag passive constructions."
🤖 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` at line 22, Split the single-line paragraph into two lines (one sentence per line) and change the passive phrasing to active voice: reword the first sentence to say that snapshot restore preserves custom policy presets you add with the commands `policy-add --from-file` or `policy-add --from-dir` (refer to that exact command text), and place the second sentence "Restored sandboxes keep the custom egress rules that were recorded with the source sandbox." on its own line; keep the existing links to Backup and Restore and Customize the Network Policy unchanged.Source: Coding guidelines
25-25: ⚡ Quick winSplit sentences onto separate lines.
This line has multiple sentences on one line, violating the style guide's requirement for one sentence per line.
📝 Suggested rewrite
-- Messaging setup refreshes stale render plans during rebuild, recovers replaced OpenClaw scope-upgrade approvals, and preinstalls Hermes WhatsApp bridge dependencies when the upstream lockfile is present. For more information, refer to [Messaging Channels](../manage-sandboxes/messaging-channels). +- Messaging setup refreshes stale render plans during rebuild, recovers replaced OpenClaw scope-upgrade approvals, and preinstalls Hermes WhatsApp bridge dependencies when the upstream lockfile is present. +For more information, refer to [Messaging Channels](../manage-sandboxes/messaging-channels).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` at line 25, The line containing "Messaging setup refreshes stale render plans during rebuild, recovers replaced OpenClaw scope-upgrade approvals, and preinstalls Hermes WhatsApp bridge dependencies when the upstream lockfile is present. For more information, refer to [Messaging Channels](../manage-sandboxes/messaging-channels)." has multiple sentences on one line; split it so each sentence is on its own line (e.g., one line for the first sentence about Messaging setup behavior and a separate line for the "For more information..." sentence), preserving the link and punctuation exactly.Source: Coding guidelines
24-24: ⚡ Quick winSplit sentences onto separate lines.
This line has multiple sentences on one line, violating the style guide's requirement for one sentence per line.
📝 Suggested rewrite
-- Inference routes choose chat completions for providers that do not expose `/v1/responses`, including NVIDIA Endpoints, NVIDIA NIM, and Gemini-compatible routes. NemoClaw also adds a targeted Nemotron Ultra 550B compatibility fix for tool-less requests. For more information, refer to [NemoClaw Inference Options](../inference/inference-options). +- Inference routes choose chat completions for providers that do not expose `/v1/responses`, including NVIDIA Endpoints, NVIDIA NIM, and Gemini-compatible routes. +NemoClaw also adds a targeted Nemotron Ultra 550B compatibility fix for tool-less requests. +For more information, refer to [NemoClaw Inference Options](../inference/inference-options).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` at line 24, The release-notes paragraph currently contains multiple sentences on one line (the line starting "Inference routes choose chat completions for providers that do not expose `/v1/responses`, including NVIDIA Endpoints, NVIDIA NIM, and Gemini-compatible routes. NemoClaw also adds a targeted Nemotron Ultra 550B compatibility fix for tool-less requests. For more information, refer to [NemoClaw Inference Options](../inference/inference-options)."); split this into three separate lines so each sentence is on its own line: one line for the inference routes sentence, one for the NemoClaw compatibility sentence, and one for the "For more information..." sentence, preserving the link and punctuation.Source: Coding guidelines
23-23: ⚡ Quick winSplit sentences onto separate lines and use active voice.
This line has the same two style guide violations:
- Multiple sentences on one line.
- Passive voice: "keeps Brave Search pinned to" should be the active "pins Brave Search to".
📝 Suggested rewrite
-- OpenClaw onboarding keeps Brave Search pinned to the NemoClaw-managed runtime and preserves the `BRAVE_API_KEY` placeholder through build doctor. Docker-driver gateway health checks now follow the entrypoint path that actually launches the in-container gateway, which avoids misleading health reports on host-gateway setups. For more information, refer to [NemoClaw CLI Commands Reference](../reference/commands). +- OpenClaw onboarding pins Brave Search to the NemoClaw-managed runtime and preserves the `BRAVE_API_KEY` placeholder through build doctor. +Docker-driver gateway health checks now follow the entrypoint path that actually launches the in-container gateway, which avoids misleading health reports on host-gateway setups. +For more information, refer to [NemoClaw CLI Commands Reference](../reference/commands).As per coding guidelines: "One sentence per line in source (makes diffs readable)." and "Active voice required. Flag passive constructions."
🤖 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` at line 23, Edit the sentence that begins "OpenClaw onboarding keeps Brave Search pinned to..." to use active voice and split sentences onto separate lines: change "keeps Brave Search pinned to" to "pins Brave Search to" and write that as its own line preserving the `BRAVE_API_KEY` placeholder, then put the Docker-driver gateway health check sentence on a separate line (you can keep the current wording "Docker-driver gateway health checks now follow the entrypoint path that actually launches the in-container gateway, avoiding misleading health reports on host-gateway setups."). Ensure each sentence is on its own line and uses active voice.Source: Coding guidelines
.agents/skills/nemoclaw-user-reference/references/troubleshooting.md (1)
372-377: ⚡ Quick winUse
$$nemoclawin alias-agnostic examples.These new generic snippets are shared across the OpenClaw and Hermes docs, so hard-coding
nemoclawmakes the generated Hermes pages render the wrong command name. Please switch the recovery example introubleshooting.mdand the newsessions export,download, anduploadexamples incommands.mdto$$nemoclaw. As per coding guidelines, alias-agnostic command examples should use the build-time placeholder.🤖 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/troubleshooting.md around lines 372 - 377, Replace hard-coded command examples using "nemoclaw" with the build-time alias placeholder "$$nemoclaw": update the two lines in troubleshooting.md that show "nemoclaw onboard --resume" and "nemoclaw <name> connect" to use "$$nemoclaw", and similarly change the new examples for "sessions export", "sessions download", and "sessions upload" in commands.md to use "$$nemoclaw" instead of "nemoclaw" so examples are alias-agnostic; search for the literal strings "nemoclaw onboard --resume", "nemoclaw <name> connect", and the three sessions example snippets to locate and replace them.Source: Coding guidelines
🤖 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.
Nitpick comments:
In @.agents/skills/nemoclaw-user-reference/references/troubleshooting.md:
- Around line 372-377: Replace hard-coded command examples using "nemoclaw" with
the build-time alias placeholder "$$nemoclaw": update the two lines in
troubleshooting.md that show "nemoclaw onboard --resume" and "nemoclaw <name>
connect" to use "$$nemoclaw", and similarly change the new examples for
"sessions export", "sessions download", and "sessions upload" in commands.md to
use "$$nemoclaw" instead of "nemoclaw" so examples are alias-agnostic; search
for the literal strings "nemoclaw onboard --resume", "nemoclaw <name> connect",
and the three sessions example snippets to locate and replace them.
In `@docs/about/release-notes.mdx`:
- Line 22: Split the single-line paragraph into two lines (one sentence per
line) and change the passive phrasing to active voice: reword the first sentence
to say that snapshot restore preserves custom policy presets you add with the
commands `policy-add --from-file` or `policy-add --from-dir` (refer to that
exact command text), and place the second sentence "Restored sandboxes keep the
custom egress rules that were recorded with the source sandbox." on its own
line; keep the existing links to Backup and Restore and Customize the Network
Policy unchanged.
- Line 25: The line containing "Messaging setup refreshes stale render plans
during rebuild, recovers replaced OpenClaw scope-upgrade approvals, and
preinstalls Hermes WhatsApp bridge dependencies when the upstream lockfile is
present. For more information, refer to [Messaging
Channels](../manage-sandboxes/messaging-channels)." has multiple sentences on
one line; split it so each sentence is on its own line (e.g., one line for the
first sentence about Messaging setup behavior and a separate line for the "For
more information..." sentence), preserving the link and punctuation exactly.
- Line 24: The release-notes paragraph currently contains multiple sentences on
one line (the line starting "Inference routes choose chat completions for
providers that do not expose `/v1/responses`, including NVIDIA Endpoints, NVIDIA
NIM, and Gemini-compatible routes. NemoClaw also adds a targeted Nemotron Ultra
550B compatibility fix for tool-less requests. For more information, refer to
[NemoClaw Inference Options](../inference/inference-options)."); split this into
three separate lines so each sentence is on its own line: one line for the
inference routes sentence, one for the NemoClaw compatibility sentence, and one
for the "For more information..." sentence, preserving the link and punctuation.
- Line 23: Edit the sentence that begins "OpenClaw onboarding keeps Brave Search
pinned to..." to use active voice and split sentences onto separate lines:
change "keeps Brave Search pinned to" to "pins Brave Search to" and write that
as its own line preserving the `BRAVE_API_KEY` placeholder, then put the
Docker-driver gateway health check sentence on a separate line (you can keep the
current wording "Docker-driver gateway health checks now follow the entrypoint
path that actually launches the in-container gateway, avoiding misleading health
reports on host-gateway setups."). Ensure each sentence is on its own line and
uses active voice.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 930eee41-572f-4585-a5a2-4036c44f6885
📒 Files selected for processing (17)
.agents/skills/nemoclaw-user-configure-inference/SKILL.md.agents/skills/nemoclaw-user-configure-inference/references/set-up-sub-agent.md.agents/skills/nemoclaw-user-deploy-remote/SKILL.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/references/backup-restore.md.agents/skills/nemoclaw-user-overview/references/ecosystem-hermes.md.agents/skills/nemoclaw-user-overview/references/ecosystem.md.agents/skills/nemoclaw-user-overview/references/overview.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.mddocs/about/release-notes.mdxdocs/manage-sandboxes/backup-restore.mdxdocs/network-policy/customize-network-policy.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdx
There was a problem hiding this comment.
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 @.github/workflows/pr.yaml:
- Around line 60-64: The CI workflow step "Install docs-only check dependencies"
now uses a multi-line run string, but test/pr-workflow-contract.test.ts still
asserts equality against a single-line value; update the assertion for
docsOnlyInstall in test/pr-workflow-contract.test.ts to use .toContain("npm
install --ignore-scripts") instead of .toBe(...), and optionally add a second
assertion to assert it contains "cd nemoclaw && npm install --ignore-scripts" so
the test accepts the multi-line run block from the workflow.
🪄 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: 40e1232a-ed2d-4717-86e0-31028ff741da
📒 Files selected for processing (1)
.github/workflows/pr.yaml
Summary
policy-add --from-fileand--from-dirsurvive snapshot restore and sandbox recreation.Source summary
docs/manage-sandboxes/backup-restore.mdx,docs/network-policy/customize-network-policy.mdx: Documents custom policy presets preserved through snapshot restore.docs/about/release-notes.mdx: Adds release-note coverage for Brave web-search pinning andBRAVE_API_KEYplaceholder preservation.docs/about/release-notes.mdx: Adds release-note coverage for Docker-driver gateway health and rootfs guard stability.docs/about/release-notes.mdx: Adds release-note coverage for chat-completions provider selection and Nemotron Ultra 550B tool-less request compatibility.docs/about/release-notes.mdx: Adds release-note coverage for messaging render plan refresh, OpenClaw scope-upgrade approval recovery, and Hermes WhatsApp bridge dependency setup..agents/skills/: Regenerates user-skill references so agent-facing guidance matches the source documentation.Verification
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdxnpm run docsnpm run build:clinpm run typecheck:cliSummary by CodeRabbit