Repository navigation
docs: clarify copyable how-to examples - #5828
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR updates documentation for onboarding, remote GPU deployment, remote TUI access, plugin builds, and docs-only checks by adding required setup details, recovery guidance, and updated command examples. ChangesExecutable docs command updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-5828.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
|
Contributor
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
miyoungc
marked this pull request as draft
June 25, 2026 23:45
|
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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/index.mdx (1)
70-74: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueRemove the trailing colon before the example.
This sentence ends with a colon even though the following block is not a list. Replace it with a period to match the docs style rules.
As per path instructions, every sentence must end with a period, and colons should only introduce lists.
🤖 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/index.mdx` around lines 70 - 74, The sentence introducing the unattended-run example in the docs currently ends with a colon, which violates the style rule for non-list introductions; update the text around the example in the docs index content so the sentence ends with a period instead, keeping the surrounding wording and the bash example unchanged.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/deployment/deploy-to-remote-gpu.mdx`:
- Around line 58-63: The deployment example in the fenced bash block is not
fully executable because BREV_INSTANCE_ID still depends on a manual placeholder.
Update the example around CHAT_UI_URL and BREV_INSTANCE_ID so it derives the
instance ID inline from brev ls --json, or remove the substitution from the
copy-pasteable command block and place it in surrounding prose. Keep the example
centered on the deploy-to-remote-gpu flow and ensure the bash snippet can run
end to end without manual edits.
- Around line 136-139: The deployment snippet does not actually stop when
BREV_INSTANCE_ID is empty, so the later export and nemoclaw onboard steps can
still run with a bad CHAT_UI_URL. Update the shell commands in this section to
enforce a hard failure using the BREV_INSTANCE_ID check, either by replacing
test -n with a parameter expansion guard or by chaining the existing steps with
&&, so the flow cannot continue unless BREV_INSTANCE_ID is set.
---
Nitpick comments:
In `@docs/index.mdx`:
- Around line 70-74: The sentence introducing the unattended-run example in the
docs currently ends with a colon, which violates the style rule for non-list
introductions; update the text around the example in the docs index content so
the sentence ends with a period instead, keeping the surrounding wording and the
bash example unchanged.
🪄 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: 41237f24-0cae-400b-a6e7-8dec4420bfa2
📒 Files selected for processing (4)
docs/deployment/deploy-to-remote-gpu.mdxdocs/deployment/install-openclaw-plugins.mdxdocs/index.mdxdocs/network-policy/approve-network-requests.mdx
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/deployment/deploy-to-remote-gpu.mdx`:
- Around line 31-34: The Brev example in the deployment guide still uses an
unresolved <gpu-type> placeholder, which leaves readers without a valid value.
Update the `brev start` example to use a concrete supported Brev GPU type or add
a nearby reference to where `brev start` documents the available GPU options, so
the guidance is complete and actionable. Refer to the `brev start` command in
the remote GPU deployment section when making the change.
🪄 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: f8b2c989-b2cb-46bc-aaab-1629e68c039e
📒 Files selected for processing (5)
docs/deployment/deploy-to-remote-gpu.mdxdocs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart.mdxdocs/index.mdxdocs/network-policy/approve-network-requests.mdx
✅ Files skipped from review due to trivial changes (3)
- docs/network-policy/approve-network-requests.mdx
- docs/index.mdx
- docs/get-started/quickstart.mdx
Contributor
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in the Show a code coverage summary of the most covered files.
Updated |
cv
approved these changes
Jun 26, 2026
This was referenced Jun 26, 2026
Hadar301
pushed a commit
to Hadar301/NemoClaw-OpenShift
that referenced
this pull request
Jul 12, 2026
<!-- markdownlint-disable MD041 --> ## Summary Clarifies the documentation examples reported in NVIDIA#5763 so readers are not blocked by undeclared hosts, dashboard URL setup, or missing plugin lockfiles. The home page stays on the default interactive install path, while scripted and failed-session recovery guidance lives in the quickstart and troubleshooting docs. ## Related Issue Fixes NVIDIA#5763 ## Changes - Keeps the home installer command concise and identifies it as the interactive installer and onboard wizard path. - Adds quickstart pointers for scripted installer reruns and failed onboarding session recovery. - Replaces the unresolved remote TUI `my-gpu-box` command with local and remote sandbox tabs. - Updates remote GPU deployment guidance to use the repository-aligned `brev create <instance-name>` provisioning shape and Brev console tunnel setup for `CHAT_UI_URL`. - Places the non-loopback dashboard exposure warning next to the first Brev tunnel setup. - Adds `package-lock.json` to the OpenClaw plugin build context example because the Dockerfile uses `npm ci`. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [x] Doc only (includes code sample changes) ## Quality Gates <!-- Check all that apply. For any "covered by existing tests", "not applicable", or waiver entry, add a brief justification on the same line or in the Changes section. --> - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: doc-only corrections to prose and copyable examples; no runtime behavior changed. - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification <!-- Check each item you ran and confirmed. Leave unchecked items you skipped. Doc-only changes do not require npm test unless you ran it. --> - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] 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) - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) `npx prek run --from-ref origin/main --to-ref HEAD` passed locally. `ReadLints` reports no diagnostics for the changed doc pages. --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
62 of 82 tasks
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
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
Clarifies the documentation examples reported in #5763 so readers are not blocked by undeclared hosts, dashboard URL setup, or missing plugin lockfiles.
The home page stays on the default interactive install path, while scripted and failed-session recovery guidance lives in the quickstart and troubleshooting docs.
Related Issue
Fixes #5763
Changes
my-gpu-boxcommand with local and remote sandbox tabs.brev create <instance-name>provisioning shape and Brev console tunnel setup forCHAT_UI_URL.package-lock.jsonto the OpenClaw plugin build context example because the Dockerfile usesnpm ci.Type of Change
Quality Gates
Verification
Verifiedin GitHubnpx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)npx prek run --from-ref origin/main --to-ref HEADpassed locally.ReadLintsreports no diagnostics for the changed doc pages.Signed-off-by: Miyoung Choi miyoungc@nvidia.com