Skip to content

docs(quickstart): keep sandbox name examples consistent#5723

Closed
WilliamK112 wants to merge 2 commits into
NVIDIA:mainfrom
WilliamK112:codex/docs-quickstart-sandbox-name-verified
Closed

docs(quickstart): keep sandbox name examples consistent#5723
WilliamK112 wants to merge 2 commits into
NVIDIA:mainfrom
WilliamK112:codex/docs-quickstart-sandbox-name-verified

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

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-claw in the terminal chat example, matching the install/onboarding output shown earlier on the page.

Related Issue

Addresses #5631 item 2.

Changes

  • Adds a short note that my-gpt-claw is the example sandbox name and should be replaced with the user's own onboarding sandbox name.
  • Updates the terminal connect example from my-assistant to my-gpt-claw.
  • Replaces CodeRabbit-flagged “review summary” wording with user-facing onboarding/install terminology.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
  • Git hooks passed during commit and push, or npx prek run --from-ref main --to-ref HEAD passes
  • Targeted tests pass for changed behavior
  • Full npm test passes (broad runtime changes only)
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Validation run:

  • git diff --check
  • npm run docs completed with 0 errors and 2 Fern warnings reported without details by default.
  • GitHub API reports both PR commits as verified with reason: valid.
  • The CodeRabbit suggestion to use $$nemoclaw was checked and intentionally not applied because npm run docs rejects $$nemoclaw in docs/get-started/quickstart.mdx: this page is a non-shared nav page and must use the literal nemoclaw command.

Signed-off-by: WilliamK112 164879897+WilliamK112@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Updated the “Chat with the Agent from the Terminal” quickstart to use the onboarding sandbox name (my-gpt-claw) instead of the previous example.
    • Clarified that readers should substitute the sandbox name they selected during onboarding (not a fixed literal).
    • Refreshed the sample nemoclaw ... connect command to match the new naming guidance.

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f07ddd20-20cd-4be9-9805-458b37670c94

📥 Commits

Reviewing files that changed from the base of the PR and between fbd5503 and e4fd4d3.

📒 Files selected for processing (1)
  • docs/get-started/quickstart.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/get-started/quickstart.mdx

📝 Walkthrough

Walkthrough

The quickstart guide’s terminal connection example now uses my-gpt-claw and clarifies that readers should use the sandbox name from onboarding.

Changes

Quickstart Documentation Fix

Layer / File(s) Summary
Terminal connect command example update
docs/get-started/quickstart.mdx
The nemoclaw ... connect example and nearby wording now reference my-gpt-claw instead of my-assistant, and note that the sandbox name comes from onboarding output.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A little claw tapped on the doc so neat,
And swapped the sandbox name to keep it sweet.
my-gpt-claw now leads the way,
In terminal chats and quickstart play.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-only quickstart update about keeping sandbox name examples consistent.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/get-started/quickstart.mdx (1)

261-262: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Use the alias-safe command placeholder in this example.

This command example should use $$nemoclaw instead 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 $$nemoclaw instead of nemoclaw/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

📥 Commits

Reviewing files that changed from the base of the PR and between 6fb9754 and fbd5503.

📒 Files selected for processing (1)
  • docs/get-started/quickstart.mdx

Comment thread docs/get-started/quickstart.mdx Outdated
@wscurran wscurran added the area: docs Documentation, examples, guides, or docs build label Jun 24, 2026
@wscurran

Copy link
Copy Markdown
Contributor

✨ 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:

@wscurran wscurran requested a review from miyoungc June 24, 2026 14:46
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@miyoungc

Copy link
Copy Markdown
Collaborator

Thanks for the docs-only fix. The remaining blocker is a merge conflict because main changed the same terminal-chat section after this branch was created.

Please resolve the conflict by keeping the newer two-terminal workflow from main, and only change the connect example's sandbox name from my-assistant to my-gpt-claw:

openshell term
nemoclaw my-gpt-claw connect
# inside the sandbox:
openclaw tui

No need to switch this example to $$nemoclaw: docs/get-started/quickstart.mdx is an OpenClaw-only page in docs/index.yml, so the literal nemoclaw command is correct here.

After rebasing/resolving the conflict, please rerun npm run docs or confirm the previous docs build still applies.

miyoungc pushed a commit that referenced this pull request Jun 30, 2026
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>
@WilliamK112

Copy link
Copy Markdown
Contributor Author

Thanks for the review. I rebased this branch locally onto current main (e4b9111f5) and applied the requested resolution: keep the newer two-terminal workflow and keep the connect example as nemoclaw my-gpt-claw connect.

After that rebase, the branch has no remaining diff from main:

I also installed dependencies with npm ci --ignore-scripts and reran the docs check via npm --script-shell=C:\msys64\usr\bin\bash.exe run docs. It reaches docs validation but fails on current main with docs/reference/commands-nemohermes.mdx is out of sync, which is unrelated to this PR because the rebased branch has no diff.

Since the intended quickstart fix is now already in main, I am closing this as superseded rather than force-pushing an empty PR branch.

Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants