docs: refresh v0.0.65 release docs#5519
Open
miyoungc wants to merge 3 commits into
Open
Conversation
miyoungc
added
area: docs
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation update for NemoClaw v0.0.65 that renames ChangesNemoClaw v0.0.65 Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 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 |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-5519.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
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
|
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in the branch is 96%. Coverage data for the branch is not yet available. Show a code coverage summary of the most covered files.
TypeScript / code-coverage/cliThe overall coverage in the branch is 46%. Coverage data for the branch is not yet available. Show a code coverage summary of the most covered files.
Updated |
Contributor
PR Review AdvisorFindings: 0 needs attention, 2 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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (6)
.agents/skills/nemoclaw-user-deploy-remote/references/install-openclaw-plugins.md (2)
63-63: ⚡ Quick winRewrite to use active voice.
Line 63 uses passive construction ("is staged"). Rephrase as an active sentence: "NemoClaw stages the Dockerfile's parent directory as the build context before the Docker build starts, so a broad directory can make onboarding look stuck while Docker is only preparing context."
🤖 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-deploy-remote/references/install-openclaw-plugins.md at line 63, Rewrite line 63 in the install-openclaw-plugins.md file to use active voice instead of passive construction. Replace the passive sentence beginning with "The Dockerfile's parent directory is staged" with the active version that begins with "NemoClaw stages the Dockerfile's parent directory" while maintaining the rest of the sentence structure and meaning about the build context preparation and its impact on onboarding performance.Source: Coding guidelines
73-73: ⚡ Quick winRewrite to use active voice.
Line 73 uses passive construction ("placed in"). Rephrase as an active sentence: "A Dockerfile in a large tree stages slowly:"
🤖 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-deploy-remote/references/install-openclaw-plugins.md at line 73, The sentence "A Dockerfile placed in a large tree stages slowly:" uses passive voice with the phrase "placed in". Rewrite this sentence to use active voice by removing the passive construction and simplifying to: "A Dockerfile in a large tree stages slowly:". This makes the sentence more direct and eliminates the unnecessary passive phrasing while maintaining the same meaning.Source: Coding guidelines
.agents/skills/nemoclaw-user-reference/references/troubleshooting.md (1)
1612-1624: 💤 Low valueSimplify the phrasing to be more direct.
Line 1624 contains "to ask the recovery path to re-establish every manifest-declared agent forward port" — the phrase "ask the recovery path to" is indirect.
More direct alternatives: "to re-establish every manifest-declared agent forward port that is missing" or simply "to recover missing forwarded ports."🎯 Proposed revision
-If `openshell forward list` does not show port `8642`, run `nemohermes <name> connect --probe-only` (or `nemohermes <name> recover`) to ask the recovery path to re-establish every manifest-declared agent forward port that has gone missing. +If `openshell forward list` does not show port `8642`, run `nemohermes <name> connect --probe-only` (or `nemohermes <name> recover`) to re-establish every manifest-declared agent forward port that is missing.🤖 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 1612 - 1624, The phrase "to ask the recovery path to re-establish every manifest-declared agent forward port that has gone missing" in the troubleshooting instructions is indirect and should be simplified. Remove the indirect "ask the recovery path to" phrasing and make it more direct by replacing it with either "to re-establish every manifest-declared agent forward port that is missing" or the more concise "to recover missing forwarded ports." This change clarifies the purpose of the nemohermes recover command without the awkward intermediary language.Source: Coding guidelines
.agents/skills/nemoclaw-user-reference/references/commands.md (1)
2250-2250: 💤 Low valueSplit the shields settle description.
LLM pattern detected. This entry packs several sentences and an em dash into one line. As per coding guidelines, keep one sentence per line in docs and avoid the em dash here.
🤖 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 2250, The NEMOCLAW_SHIELDS_SETTLE_MS table entry description packs multiple sentences and an em dash into a single line, which violates documentation guidelines. Split the description for this configuration variable into multiple sentences, with one sentence per line, and replace the em dash with appropriate punctuation or restructure the text to maintain clarity while following the one-sentence-per-line pattern used in the documentation style guide.Source: Coding guidelines
.agents/skills/nemoclaw-user-overview/references/release-notes.md (1)
13-19: 💤 Low valueSplit the release-note bullets onto separate lines.
LLM pattern detected. Each added bullet combines the summary sentence and the
For more informationsentence on the same line. As per coding guidelines, keep one sentence per line in docs.🤖 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-overview/references/release-notes.md around lines 13 - 19, In the release-notes.md file, each bullet point currently combines the feature summary sentence with the "For more information" reference sentence on the same line. Refactor each of the five bullets (lines 13-19) by placing each "For more information" reference on a separate line within the same bullet point, following the one-sentence-per-line documentation guideline. This applies to all bullets that describe Gateway and sandbox recovery, Rebuild and restore flows, Onboarding and inference setup, Day-two CLI operations, Messaging activation, Hermes defaults, and Release validation.Source: Coding guidelines
docs/about/release-notes.mdx (1)
22-27: ⚡ Quick winSplit multiple sentences onto separate lines per style guide.
Each bullet point (lines 22–27) contains multiple sentences on a single line, which violates the guideline "Keep one sentence per line in Markdown and MDX source files."
This impacts diff readability and makes peer review harder.
For example, line 22 has "Gateway and sandbox recovery now wait… gateways." followed by "For more information, refer to …" on the same line.📝 Proposed structure (example for line 22)
- Gateway and sandbox recovery now wait for sustained serving state, recover sandboxes whose active gateway has lost its spec, preserve gateway routing state across more rebuilds, and allocate dashboard ports across multiple NemoClaw gateways. For more information, refer to [Manage Sandbox Lifecycle](../manage-sandboxes/lifecycle) and [Troubleshooting](../reference/troubleshooting). + Gateway and sandbox recovery now wait for sustained serving state, recover sandboxes whose active gateway has lost its spec, preserve gateway routing state across more rebuilds, and allocate dashboard ports across multiple NemoClaw gateways. + For more information, refer to [Manage Sandbox Lifecycle](../manage-sandboxes/lifecycle) and [Troubleshooting](../reference/troubleshooting).Apply this split to all six bullet points (lines 22, 23, 24, 25, 26, 27).
🤖 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 22 - 27, The release notes contain multiple sentences per line in each bullet point, violating the style guide requirement of one sentence per line. Split each of the six bullet points (covering Gateway and sandbox recovery, Rebuild and restore flows, Onboarding and inference setup, Day-two CLI operations, Messaging activation, and Hermes defaults) so that each sentence appears on its own line. This includes separating the main description from the "For more information" reference sentences that currently appear at the end of each bullet point.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-deploy-remote/references/install-openclaw-plugins.md:
- Line 63: Rewrite line 63 in the install-openclaw-plugins.md file to use active
voice instead of passive construction. Replace the passive sentence beginning
with "The Dockerfile's parent directory is staged" with the active version that
begins with "NemoClaw stages the Dockerfile's parent directory" while
maintaining the rest of the sentence structure and meaning about the build
context preparation and its impact on onboarding performance.
- Line 73: The sentence "A Dockerfile placed in a large tree stages slowly:"
uses passive voice with the phrase "placed in". Rewrite this sentence to use
active voice by removing the passive construction and simplifying to: "A
Dockerfile in a large tree stages slowly:". This makes the sentence more direct
and eliminates the unnecessary passive phrasing while maintaining the same
meaning.
In @.agents/skills/nemoclaw-user-overview/references/release-notes.md:
- Around line 13-19: In the release-notes.md file, each bullet point currently
combines the feature summary sentence with the "For more information" reference
sentence on the same line. Refactor each of the five bullets (lines 13-19) by
placing each "For more information" reference on a separate line within the same
bullet point, following the one-sentence-per-line documentation guideline. This
applies to all bullets that describe Gateway and sandbox recovery, Rebuild and
restore flows, Onboarding and inference setup, Day-two CLI operations, Messaging
activation, Hermes defaults, and Release validation.
In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 2250: The NEMOCLAW_SHIELDS_SETTLE_MS table entry description packs
multiple sentences and an em dash into a single line, which violates
documentation guidelines. Split the description for this configuration variable
into multiple sentences, with one sentence per line, and replace the em dash
with appropriate punctuation or restructure the text to maintain clarity while
following the one-sentence-per-line pattern used in the documentation style
guide.
In @.agents/skills/nemoclaw-user-reference/references/troubleshooting.md:
- Around line 1612-1624: The phrase "to ask the recovery path to re-establish
every manifest-declared agent forward port that has gone missing" in the
troubleshooting instructions is indirect and should be simplified. Remove the
indirect "ask the recovery path to" phrasing and make it more direct by
replacing it with either "to re-establish every manifest-declared agent forward
port that is missing" or the more concise "to recover missing forwarded ports."
This change clarifies the purpose of the nemohermes recover command without the
awkward intermediary language.
In `@docs/about/release-notes.mdx`:
- Around line 22-27: The release notes contain multiple sentences per line in
each bullet point, violating the style guide requirement of one sentence per
line. Split each of the six bullet points (covering Gateway and sandbox
recovery, Rebuild and restore flows, Onboarding and inference setup, Day-two CLI
operations, Messaging activation, and Hermes defaults) so that each sentence
appears on its own line. This includes separating the main description from the
"For more information" reference sentences that currently appear at the end of
each bullet point.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 21529ca3-3683-4e79-8ae9-e672091f98c5
📒 Files selected for processing (13)
.agents/skills/nemoclaw-user-configure-inference/references/inference-options.md.agents/skills/nemoclaw-user-configure-inference/references/set-up-sub-agent.md.agents/skills/nemoclaw-user-configure-security/references/credential-storage.md.agents/skills/nemoclaw-user-deploy-remote/references/install-openclaw-plugins.md.agents/skills/nemoclaw-user-get-started/SKILL.md.agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md.agents/skills/nemoclaw-user-manage-policy/references/approve-network-requests.md.agents/skills/nemoclaw-user-overview/references/release-notes.md.agents/skills/nemoclaw-user-reference/references/commands.md.agents/skills/nemoclaw-user-reference/references/network-policies.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.mddocs/about/release-notes.mdxfern/fern.config.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes release-prep documentation for NemoClaw v0.0.65.
Adds the v0.0.65 release-notes section and refreshes generated
nemoclaw-user-*skills from the Fern MDX source docs.Changes
docs/about/release-notes.mdxwith links to the deeper docs pages for lifecycle, troubleshooting, inference, CLI commands, messaging, credentials, network policy, Hermes, and sub-agents.nemoclaw-user-*skills withscripts/docs-to-skills.pyso release-prep skill output matches the merged source docs.Source Summary
docs/about/release-notes.mdx: Documents deadline-based gateway wait reliability in the v0.0.65 recovery summary.docs/about/release-notes.mdx: Documents re-execed OpenClaw gateway health check recovery in the sandbox recovery summary.docs/about/release-notes.mdx: Documents safer uninstall TTY confirmation behavior in the day-two CLI summary.docs/about/release-notes.mdx: Documents fail-closed config restore merge behavior in the rebuild and restore summary.docs/about/release-notes.mdx: Documents WeChat QR token redaction in the messaging summary.docs/about/release-notes.mdx: Documents sustained gateway serving checks in the recovery summary.docs/about/release-notes.mdx: Documents model-router teardown during uninstall in the day-two CLI summary.docs/about/release-notes.mdx: Documents Shields auto-restore lock reconfirmation in the rebuild and restore summary.docs/about/release-notes.mdx: Documents Docker Desktop WSL CDI injection failure handling in the onboarding diagnostics summary.docs/about/release-notes.mdx: Documents sandbox download/upload wrappers and sessions export in the day-two CLI summary.docs/about/release-notes.mdx: Documents reporter-owned model metadata preservation in the rebuild and restore summary.docs/about/release-notes.mdx: Documents managed vLLM model preflight before side effects in the inference setup summary.docs/about/release-notes.mdx: Documents managed vLLM extra serve arguments in the inference setup summary.docs/about/release-notes.mdx: Documents silent OpenClaw runtime fallback surfacing in the onboarding diagnostics summary.docs/about/release-notes.mdx: Documents persisted sandbox gateway lookup in the gateway recovery summary.docs/about/release-notes.mdx: Documents sub-agent gateway dial-back through the sandbox interface in the Hermes and sub-agent summary.docs/about/release-notes.mdx: Documents Discord per-account proxy resolution in the messaging summary.docs/about/release-notes.mdx: Documents reserved Hermes port8642handling in the Hermes compatibility summary.docs/about/release-notes.mdx: Documents the narrower Hermes baseline policy in the Hermes compatibility summary.docs/about/release-notes.mdx: Documents restored gateway guard chains in the gateway recovery summary.docs/about/release-notes.mdx: Documents compact persisted messaging plans in the messaging summary.docs/about/release-notes.mdx: Documents manifest channel migration in the messaging summary.docs/about/release-notes.mdx: Documents persisted agent preservation through registry recovery in the rebuild and restore summary..agents/skills/nemoclaw-user-reference/references/commands.md: Refreshes generated skill output for custom build cache and layer-ordering source docs.docs/about/release-notes.mdx: Documents dashboard port allocation across multiple NemoClaw gateways in the recovery summary.docs/about/release-notes.mdx: Documents recovery when an active gateway has no sandbox spec in the recovery summary..agents/skills/nemoclaw-user-reference/references/troubleshooting.md: Refreshes generated skill output for declared agentforward_portsrecovery source docs.docs/about/release-notes.mdx: Documents bounded compatible endpoint probes in the inference setup summary.docs/about/release-notes.mdx: Documents provider credential hash removal from sandbox registry entries in the messaging summary.docs/about/release-notes.mdx: Documents summarized inference validation failures in the onboarding diagnostics summary.docs/about/release-notes.mdx: Documents context-window recomputation after runtime model switches in the inference setup summary.docs/about/release-notes.mdx: Documents cleanup of hard-coded messaging channel stragglers in the messaging summary.Skipped
docs/.docs-skipentries through skipped experimental paths, so this PR does not add new release-note text for that commit.Type of Change
Verification
npx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Verification notes:
npm run docspassed after rerunning outside the sandbox. Fern reported 0 errors and 1 hidden warning.npm run docsattempt failed before validation becausetsxcould not create its local IPC pipe under sandbox restrictions.npm run build:clipassed before push to refresh the localdist/artifacts used by the CLI typecheck hook.npm testwas not run because this is a docs-only release refresh.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
New Features
NEMOCLAW_VLLM_EXTRA_ARGS_JSON.Documentation
NVIDIA_INFERENCE_API_KEY.Tests