docs(quickstart): keep sandbox name examples consistent#5723
docs(quickstart): keep sandbox name examples consistent#5723WilliamK112 wants to merge 2 commits into
Conversation
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
|
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 (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe quickstart guide’s terminal connection example now uses ChangesQuickstart Documentation Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 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: 1
🧹 Nitpick comments (1)
docs/get-started/quickstart.mdx (1)
261-262: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse the alias-safe command placeholder in this example.
This command example should use
$$nemoclawinstead of a concrete alias so shared docs render correctly for OpenClaw and Hermes variants.As per path instructions, command examples that work across NemoClaw agent aliases should use
$$nemoclawinstead ofnemoclaw/nemohermes.🤖 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/get-started/quickstart.mdx` around lines 261 - 262, The quickstart command example uses a concrete agent alias instead of the shared placeholder, so update the example in the docs snippet to use the alias-safe $$nemoclaw form. Locate the command example around the connect instruction in the quickstart content and replace the hardcoded alias so the same snippet renders correctly for OpenClaw and Hermes variants.Source: Path instructions
🤖 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/get-started/quickstart.mdx`:
- Line 259: Update the quickstart copy to use the same user-facing
onboarding/install terminology used elsewhere on the page instead of “review
summary.” In the relevant example text, replace the PR/process phrasing with
wording that tells the reader to use the sandbox name they entered during
onboarding, keeping the reference aligned with the quickstart flow and the
existing install output language.
---
Nitpick comments:
In `@docs/get-started/quickstart.mdx`:
- Around line 261-262: The quickstart command example uses a concrete agent
alias instead of the shared placeholder, so update the example in the docs
snippet to use the alias-safe $$nemoclaw form. Locate the command example around
the connect instruction in the quickstart content and replace the hardcoded
alias so the same snippet renders correctly for OpenClaw and Hermes variants.
🪄 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: a93706ab-0e08-4032-8b4e-4e0db8a1e34c
📒 Files selected for processing (1)
docs/get-started/quickstart.mdx
|
✨ Thanks for rebuilding the docs-only change on a GitHub Verified signed commit to supersede the previous PR. This proposes a way to keep sandbox name examples consistent in the quickstart guide by clarifying that readers should replace the example name with their chosen sandbox name during onboarding. Related open PRs: Related open issues: |
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
|
Thanks for the docs-only fix. The remaining blocker is a merge conflict because Please resolve the conflict by keeping the newer two-terminal workflow from openshell termnemoclaw my-gpt-claw connect
# inside the sandbox:
openclaw tuiNo need to switch this example to After rebasing/resolving the conflict, please rerun |
Addresses the actionable findings from the 2026-06-19 doc-validate run across 11 guide pages. Closes #5630 Refs #5631 Closes #5632 Closes #5633 Closes #5634 Closes #5635 Closes #5636 Closes #5637 Closes #5638 Closes #5639 Closes #5640 | Issue | Page | Fix | |-------|------|-----| | #5630 | manage-sandboxes/lifecycle | bump stale NEMOCLAW_INSTALL_TAG example v0.0.63 → v0.0.65 | | #5631 | get-started/quickstart | self-contained non-interactive install (provider/key/sandbox name); consistent sandbox name | | #5632 | inference/set-up-sub-agent | guidance for non-Omni sub-agent configs (auth-profiles upload already documented) | | #5633 | inference/switch-inference-providers | show `credentials list` to discover provider names before switching | | #5634 | network-policy/integration-policy-examples | note `policy-add` is non-idempotent; remove before re-applying | | #5635 | inference/inference-options | state vLLM install + running-server prerequisites | | #5636 | inference/use-local-inference | add `--yes-i-accept-third-party-software` to non-interactive Ollama; add `docker network inspect` subnet discovery | | #5637 | reference/troubleshooting | nvm/Docker prerequisites note; make CA-bundle grep non-zero-safe (`|| true`) | | #5638 | deployment/sandbox-hardening | explain `nemoclaw-sandbox` image placeholder; Landlock verify expected output/fallback | | #5639 | manage-sandboxes/messaging-channels | quote angle-bracket credential placeholders | | #5640 | monitoring/monitor-sandbox-activity | correct legacy `sandbox exec` → `<name> exec --`; placeholder names; context-overflow `/reset` remediation | #5631 is referenced rather than closed: this PR fixes the quickstart docs (the non-interactive block now lists the required provider/key/sandbox-name vars, and the `connect` example uses a consistent sandbox name). The exit-1 failure in item 1 is an installer bug, root-caused in #5626 with the fix in flight at #5641, and item 2's name consistency is also covered by #5723. #5631 should close once those land, not on this docs PR. Not changed (with rationale): - The recurring "`$$nemoclaw` breaks copy-paste" finding (#5630, #5634, #5635, #5636, #5639, #5640): `$$nemoclaw` is the intentional `CLI_SENTINEL` replaced at build time by scripts/sync-agent-variant-docs.ts (and required on shared nav pages by `assertNoUnsharedPlaceholders`). It renders as `nemoclaw`/`nemohermes` in published docs, so it is correct as-is; the validator scanned raw MDX rather than rendered output. - #5637 "v0.0.43" string: kept — it is a historical "starting with version X" statement, not a stale version. - Some findings (#5636 hermes tool-calling-reliability link, #5639 hermes deploy link and backtick) are already resolved in current source (links are `AgentOnly variant="openclaw"` gated; backticks balanced). Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Strengthened sandbox hardening guidance with clearer runtime capability-dropping instructions and more explicit Landlock detection/fallback behavior. * Refreshed quickstart and installer/CLI examples, including corrected sandbox naming and a more reliable non-interactive install flow. * Updated inference setup materials (vLLM sequencing, endpoint readiness, provider discovery/selection, and streamlined sub-agent JSON editing). * Improved local inference, sandbox lifecycle install tag, monitoring command examples, and added context-reset troubleshooting. * Enhanced messaging/network-policy/troubleshooting snippets with safer quoting and more resilient command behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com>
|
Thanks for the review. I rebased this branch locally onto current After that rebase, the branch has no remaining diff from
I also installed dependencies with Since the intended quickstart fix is now already in |
…A#5640) (NVIDIA#5645) Addresses the actionable findings from the 2026-06-19 doc-validate run across 11 guide pages. Closes NVIDIA#5630 Refs NVIDIA#5631 Closes NVIDIA#5632 Closes NVIDIA#5633 Closes NVIDIA#5634 Closes NVIDIA#5635 Closes NVIDIA#5636 Closes NVIDIA#5637 Closes NVIDIA#5638 Closes NVIDIA#5639 Closes NVIDIA#5640 | Issue | Page | Fix | |-------|------|-----| | NVIDIA#5630 | manage-sandboxes/lifecycle | bump stale NEMOCLAW_INSTALL_TAG example v0.0.63 → v0.0.65 | | NVIDIA#5631 | get-started/quickstart | self-contained non-interactive install (provider/key/sandbox name); consistent sandbox name | | NVIDIA#5632 | inference/set-up-sub-agent | guidance for non-Omni sub-agent configs (auth-profiles upload already documented) | | NVIDIA#5633 | inference/switch-inference-providers | show `credentials list` to discover provider names before switching | | NVIDIA#5634 | network-policy/integration-policy-examples | note `policy-add` is non-idempotent; remove before re-applying | | NVIDIA#5635 | inference/inference-options | state vLLM install + running-server prerequisites | | NVIDIA#5636 | inference/use-local-inference | add `--yes-i-accept-third-party-software` to non-interactive Ollama; add `docker network inspect` subnet discovery | | NVIDIA#5637 | reference/troubleshooting | nvm/Docker prerequisites note; make CA-bundle grep non-zero-safe (`|| true`) | | NVIDIA#5638 | deployment/sandbox-hardening | explain `nemoclaw-sandbox` image placeholder; Landlock verify expected output/fallback | | NVIDIA#5639 | manage-sandboxes/messaging-channels | quote angle-bracket credential placeholders | | NVIDIA#5640 | monitoring/monitor-sandbox-activity | correct legacy `sandbox exec` → `<name> exec --`; placeholder names; context-overflow `/reset` remediation | NVIDIA#5631 is referenced rather than closed: this PR fixes the quickstart docs (the non-interactive block now lists the required provider/key/sandbox-name vars, and the `connect` example uses a consistent sandbox name). The exit-1 failure in item 1 is an installer bug, root-caused in NVIDIA#5626 with the fix in flight at NVIDIA#5641, and item 2's name consistency is also covered by NVIDIA#5723. NVIDIA#5631 should close once those land, not on this docs PR. Not changed (with rationale): - The recurring "`$$nemoclaw` breaks copy-paste" finding (NVIDIA#5630, NVIDIA#5634, NVIDIA#5635, NVIDIA#5636, NVIDIA#5639, NVIDIA#5640): `$$nemoclaw` is the intentional `CLI_SENTINEL` replaced at build time by scripts/sync-agent-variant-docs.ts (and required on shared nav pages by `assertNoUnsharedPlaceholders`). It renders as `nemoclaw`/`nemohermes` in published docs, so it is correct as-is; the validator scanned raw MDX rather than rendered output. - NVIDIA#5637 "v0.0.43" string: kept — it is a historical "starting with version X" statement, not a stale version. - Some findings (NVIDIA#5636 hermes tool-calling-reliability link, NVIDIA#5639 hermes deploy link and backtick) are already resolved in current source (links are `AgentOnly variant="openclaw"` gated; backticks balanced). Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Strengthened sandbox hardening guidance with clearer runtime capability-dropping instructions and more explicit Landlock detection/fallback behavior. * Refreshed quickstart and installer/CLI examples, including corrected sandbox naming and a more reliable non-interactive install flow. * Updated inference setup materials (vLLM sequencing, endpoint readiness, provider discovery/selection, and streamlined sub-agent JSON editing). * Improved local inference, sandbox lifecycle install tag, monitoring command examples, and added context-reset troubleshooting. * Enhanced messaging/network-policy/troubleshooting snippets with safer quoting and more resilient command behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com>
Summary
Supersedes #5675 with the same docs-only fix rebuilt on GitHub Verified signed commits, because force-push is not allowed on the original PR branch. Keeps the OpenClaw quickstart sandbox name consistent by using
my-gpt-clawin the terminal chat example, matching the install/onboarding output shown earlier on the page.Related Issue
Addresses #5631 item 2.
Changes
my-gpt-clawis the example sandbox name and should be replaced with the user's own onboarding sandbox name.connectexample frommy-assistanttomy-gpt-claw.Type of Change
Verification
Verifiedin GitHubnpx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Validation run:
git diff --checknpm run docscompleted with 0 errors and 2 Fern warnings reported without details by default.reason: valid.$$nemoclawwas checked and intentionally not applied becausenpm run docsrejects$$nemoclawindocs/get-started/quickstart.mdx: this page is a non-shared nav page and must use the literalnemoclawcommand.Signed-off-by: WilliamK112 164879897+WilliamK112@users.noreply.github.com
Summary by CodeRabbit
my-gpt-claw) instead of the previous example.nemoclaw ... connectcommand to match the new naming guidance.