docs: document remaining 0.0.57 behavior changes#4717
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThis PR updates NemoClaw documentation to reflect behavioral enhancements across onboarding, multi-gateway deployments, connection management, status reporting, and failure handling. Changes span both skill-level and main user documentation to maintain consistency. ChangesNemoClaw CLI and Infrastructure Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 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-4717.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Dispatch hint: Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
Dispatch hint
|
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
PR Review AdvisorFindings: 0 needs attention, 1 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
This is an automated advisory review. A human maintainer must make the final merge decision. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/inference/use-local-inference.mdx (1)
376-376: ⚡ Quick winFormat the CLI command as inline code.
Use
docker pullinstead of plain text in this sentence to match docs command-formatting rules.As per coding guidelines, "CLI commands, file paths, flags, parameter names, and values must use inline
codeformatting."🤖 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/inference/use-local-inference.mdx` at line 376, Update the sentence that currently reads "If Docker pull output stops making progress..." to format the CLI command as inline code: replace the plain text docker pull with inline `docker pull` so it follows the docs' CLI command formatting rules.
🤖 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 `@docs/manage-sandboxes/lifecycle.mdx`:
- Around line 175-176: The docs mention using NEMOCLAW_GATEWAY_PORT to run
separate OpenShell gateways but the sample onboarding commands don't set it;
update the example commands (the ones that call onboard/onboarding) to
explicitly set NEMOCLAW_GATEWAY_PORT=<port> before each run (e.g.,
NEMOCLAW_GATEWAY_PORT=8001 ... onboard and NEMOCLAW_GATEWAY_PORT=8002 ...
onboard) so readers see concrete per-port onboarding usage and understand ports
isolate gateway name and local state.
---
Nitpick comments:
In `@docs/inference/use-local-inference.mdx`:
- Line 376: Update the sentence that currently reads "If Docker pull output
stops making progress..." to format the CLI command as inline code: replace the
plain text docker pull with inline `docker pull` so it follows the docs' CLI
command formatting rules.
🪄 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: 4ecab909-8419-4b86-aaa0-ddae5bcae08c
📒 Files selected for processing (14)
.agents/skills/nemoclaw-user-configure-inference/SKILL.md.agents/skills/nemoclaw-user-configure-inference/references/switch-inference-providers.md.agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md.agents/skills/nemoclaw-user-manage-sandboxes/references/messaging-channels.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.mddocs/inference/switch-inference-providers.mdxdocs/inference/use-local-inference.mdxdocs/manage-sandboxes/lifecycle.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/troubleshooting.mdx
Summary
Adds the follow-up source documentation that was identified after the 0.0.57 release-docs refresh merged. The PR fills remaining coverage gaps for route reconciliation, re-onboard policy persistence, per-port gateways, stale sandbox recovery, Docker-driver status details, managed vLLM progress, and Slack channel startup behavior.
Related Issue
None.
Changes
connectwarnings for gateway-vs-registry inference route mismatches, registry-preserving stale sandbox recovery, andinference setregistry-first behavior with rebuild guidance.Type of Change
Verification
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdxnpm run docs:sync-agent-variantsnpm run docsrg "permissive mode|shields down|shields up|shields status|config rotate-token|rotate-token" docs --glob "*.mdx"rg "permissive mode|shields down|shields up|shields status|config rotate-token|rotate-token" .agents/skills --glob "*.md"Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit