docs: prepare 0.0.36 release docs#3151
Conversation
|
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 updates for NemoClaw v0.0.36 introduce the "Model Router" inference provider option, replace the ChangesModel Router Feature & Config Immutability Workflow
Sequence Diagram(s)sequenceDiagram
participant Sandbox as Sandbox (in-sandbox)
participant OpenShell as OpenShell Gateway
participant Router as Host Model Router
participant NVIDIA as NVIDIA Endpoint
Sandbox->>OpenShell: HTTPS POST https://inference.local/v1 (inference request)
OpenShell->>Router: Forward routed request (if provider = Model Router)
Router->>NVIDIA: Select model from pool -> call NVIDIA endpoint (uses host-held creds)
NVIDIA-->>Router: Inference response
Router-->>OpenShell: Response proxied back
OpenShell-->>Sandbox: Return inference result
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
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 |
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
docs/inference/set-up-sub-agent.md (1)
79-79: ⚡ Quick winConsider splitting this sentence for readability.
Line 79 combines two independent clauses with a semicolon, making it harder to parse. Breaking it into two sentences would improve clarity and align with the one-sentence-per-line guideline that makes diffs more readable.
Suggested revision:
-In the default mutable state, this keeps the local hash consistent but does not make it tamper-proof; lock the config root-owned and read-only afterward if the sandbox should enforce config integrity at startup. +In the default mutable state, this keeps the local hash consistent but does not make it tamper-proof. +Lock the config root-owned and read-only afterward if the sandbox should enforce config integrity at startup.🤖 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/set-up-sub-agent.md` at line 79, The sentence beginning "In the default mutable state, this keeps the local hash consistent but does not make it tamper-proof; lock the config root-owned and read-only afterward if the sandbox should enforce config integrity at startup." should be split into two clearer sentences: end the first after "tamper‑proof." and start a second instructing to "lock the config root-owned and read-only afterward if the sandbox should enforce config integrity at startup." Update the document text accordingly to improve readability and align with the one-sentence-per-line guideline.docs/reference/commands.md (1)
237-237: 💤 Low valueConsider US spelling: "honored" instead of "honoured".
Line 237 uses British spelling "honoured." Technical documentation typically uses US English spelling for consistency.
-When prompting is impossible (no TTY or `--non-interactive`), the env var is also honoured so existing CI scripts keep working. +When prompting is impossible (no TTY or `--non-interactive`), the env var is also honored so existing CI scripts keep working.🤖 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/reference/commands.md` at line 237, Change the British spelling "honoured" to US spelling "honored" in the sentence "When prompting is impossible (no TTY or `--non-interactive`), the env var is also honoured so existing CI scripts keep working." so it reads "…the env var is also honored…".
🤖 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/about/ecosystem.md`:
- Line 89: The table cell under "Filesystem policy" contains three sentences on
one line; split them so each sentence is on its own source line to follow "one
sentence per line" guideline—edit the table row containing "Filesystem policy"
(the cell mentioning "The community sandbox bundles a policy for OpenClaw.
NemoClaw defines a targeted read-only and read-write layout. System paths...")
and break the sentences into separate lines (either by inserting <br/> tags
where appropriate or reformatting the cell so each sentence is a separate line)
while preserving the same content and meaning.
In `@docs/get-started/quickstart.md`:
- Around line 209-234: The Model Router dropdown block has mismatched MyST
directive fences: it opens with four-colon fences (::::) but closes with three
(:::); update the closing fence to match the opening (use ::::: or change the
opening to :::) so the Option 8 "Model Router" dropdown block uses consistent
fence markers (refer to the "Option 8: Model Router" dropdown and the
surrounding opening '::::' and closing ':::' markers) to restore proper MyST
parsing/rendering.
In `@docs/reference/troubleshooting.md`:
- Line 673: The paragraph starting with "Host-side `config set` validates any
HTTP or HTTPS URLs..." in docs/reference/troubleshooting.md contains multiple
sentences on one line; split that single line into four separate lines so each
sentence is on its own line: 1) "Host-side `config set` validates any HTTP or
HTTPS URLs in the new value, including URLs nested inside JSON objects or
arrays." 2) "NemoClaw rejects loopback, private, reserved, and internal hosts;
DNS names must resolve successfully and must not resolve to private/internal
addresses." 3) "HTTP URLs are written with the validated IP address pinned to
reduce DNS-rebinding risk." 4) "Avoid putting credentials in config values;
rotate provider credentials with the credential-management commands instead."
Ensure the surrounding paragraph structure is preserved.
---
Nitpick comments:
In `@docs/inference/set-up-sub-agent.md`:
- Line 79: The sentence beginning "In the default mutable state, this keeps the
local hash consistent but does not make it tamper-proof; lock the config
root-owned and read-only afterward if the sandbox should enforce config
integrity at startup." should be split into two clearer sentences: end the first
after "tamper‑proof." and start a second instructing to "lock the config
root-owned and read-only afterward if the sandbox should enforce config
integrity at startup." Update the document text accordingly to improve
readability and align with the one-sentence-per-line guideline.
In `@docs/reference/commands.md`:
- Line 237: Change the British spelling "honoured" to US spelling "honored" in
the sentence "When prompting is impossible (no TTY or `--non-interactive`), the
env var is also honoured so existing CI scripts keep working." so it reads "…the
env var is also honored…".
🪄 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: 1dfc8914-2e6a-4a28-b794-12d4fd26e691
📒 Files selected for processing (33)
.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/set-up-sub-agent.md.agents/skills/nemoclaw-user-configure-security/references/best-practices.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-hermes.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/messaging-channels.md.agents/skills/nemoclaw-user-overview/references/ecosystem.md.agents/skills/nemoclaw-user-overview/references/how-it-works.md.agents/skills/nemoclaw-user-overview/references/overview.md.agents/skills/nemoclaw-user-reference/references/architecture.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/ecosystem.mddocs/about/how-it-works.mddocs/about/overview.mddocs/deployment/sandbox-hardening.mddocs/get-started/quickstart-hermes.mddocs/get-started/quickstart.mddocs/inference/inference-options.mddocs/inference/set-up-sub-agent.mddocs/inference/use-local-inference.mddocs/project.jsondocs/reference/architecture.mddocs/reference/commands.mddocs/reference/network-policies.mddocs/reference/troubleshooting.mddocs/security/best-practices.mddocs/versions1.json
Summary
docs/.docs-skip.Source summary
docs/get-started/quickstart.md,docs/inference/inference-options.md,docs/reference/architecture.md: Document Model Router setup and routed inference architecture.docs/get-started/quickstart.md,docs/reference/commands.md: Document deployment verification and HTTP 401 health handling.docs/inference/inference-options.md: Document retry behavior for transient provider validation failures.docs/reference/architecture.md: Document agent-scoped model/provider compatibility manifests.docs/reference/architecture.md: Tie model-specific compatibility setup to known model/provider behavior.docs/inference/use-local-inference.md: Document Ollama tool-calling capability validation.docs/reference/commands.md: DocumentNEMOCLAW_SANDBOX_NAMEas the interactive sandbox-name default.docs/get-started/quickstart-hermes.md,docs/reference/network-policies.md: Document Hermes agent-specific baseline policy endpoints.Test plan
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-usermake docsnpm run build:clirgskip-term scan fordocs/and generated user skillsMade with Cursor
Summary by CodeRabbit
New Features
local-inferencenetwork policy preset.Documentation
Improvements