docs: clarify quickstart non-interactive setup by miyoungc · Pull Request #6514 · NVIDIA/NemoClaw

miyoungc · 2026-07-09T00:05:15Z

Summary

Clarifies the OpenClaw quickstart non-interactive install guidance by linking directly to the provider selection section instead of referring to a provider table by relative position.

Related Issue

Fixes #5631

Changes

Update docs/get-started/quickstart.mdx to point readers to Choose an Inference Provider from the non-interactive install guidance.

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)

Quality Gates

Tests added or updated for changed behavior
Existing tests cover changed behavior — justification:
Tests not applicable — justification: docs-only anchor wording change; no executable behavior changed
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

PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: Tests not applicable; docs-only anchor wording change
Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
Quality Gates section completed with required justifications or waivers
No secrets, API keys, or credentials committed
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)

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

coderabbitai · 2026-07-09T00:05:38Z

📝 Walkthrough

Walkthrough

This PR updates the quickstart documentation’s provider-table reference and adds a Vitest regression test that checks the non-interactive install block, required environment variables, and sandbox name consistency.

Changes

Quickstart doc fix and validation test

Layer / File(s)	Summary
Provider table reference correction `docs/get-started/quickstart.mdx`	Updates a sentence to reference the provider table "below" instead of "above" for setting `NEMOCLAW_PROVIDER`, API key, and `NEMOCLAW_SANDBOX_NAME`.
Quickstart documentation test suite `test/quickstart-docs-5631.test.ts`	Adds a test that reads `quickstart.mdx`, collects fenced bash code blocks, and asserts install/config lines, ordering text, and unique sandbox name (`my-gpt-claw`) using helper functions for block extraction and regex-based unique matching.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The docs change and regression test address the required env vars and consistent sandbox name from issue `#5631`.
Out of Scope Changes check	✅ Passed	The only code changes are the targeted docs fix and its regression test, which are in scope for the issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and accurately reflects the main docs change to clarify the quickstart non-interactive setup.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch codex/resolve-5631-quickstart-docs

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

github-actions · 2026-07-09T00:11:35Z

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

None. Docs-only change that updates an internal reference link in the quickstart. It cannot affect runtime or real user flows, so no E2E is needed.

Optional E2E

None.

New E2E recommendations

None.

github-actions · 2026-07-09T00:11:37Z

E2E Target Recommendation

Required E2E targets: None
Optional E2E targets: None

Workflow run

Full E2E target advisor summary

E2E Target Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E targets

None. Docs-only change outside test/e2e and e2e.yaml; it cannot affect E2E target behavior.

Optional E2E targets

None.

Relevant changed files

None.

github-actions · 2026-07-09T00:12:07Z

🌿 Preview your docs: https://nvidia-preview-pr-6514.docs.buildwithfern.com/nemoclaw

github-actions · 2026-07-09T00:13:05Z

PR Review Advisor (Nemotron Ultra) — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: Consider PRA-1: Coordinate merge order with PR #6461 (OpenRouter onboarding support).
Open items: 0 required · 0 warnings · 1 suggestion · 0 test follow-ups
Since last review: 0 prior items resolved · 1 still applies · 0 new items found

Action checklist

PRA-1 In-scope improvement: Coordinate merge order with PR feat(inference): add OpenRouter onboarding support #6461 (OpenRouter onboarding support) in docs/get-started/quickstart.mdx:1

Findings index

ID	Severity	Category	Location	Required action
`PRA-1`	Improvement	architecture	`docs/get-started/quickstart.mdx:1`	Coordinate with PR #6461 author to ensure clean merge; no code change needed in this PR.

Review findings by urgency: 0 required fixes, 0 items to resolve/justify, 1 in-scope improvement

⚠️ Resolve or justify before merge

Investigate these in the current review; either fix them, explain why they are not applicable, or document the accepted risk.

None.

💡 In-scope improvements

These are lower-risk, not throwaway. Prefer fixing them in this PR when they are local to changed code; defer only with rationale or a linked follow-up.

`PRA-1` Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

Location: docs/get-started/quickstart.mdx:1
Category: architecture
Problem: PR feat(inference): add OpenRouter onboarding support #6461 'feat(inference): add OpenRouter onboarding support' also modifies docs/get-started/quickstart.mdx. Both PRs touch the same file and may require conflict resolution on merge.
Impact: Potential merge conflicts if both PRs are merged without coordination. No code defect in this PR.
Suggested action: Coordinate with PR feat(inference): add OpenRouter onboarding support #6461 author to ensure clean merge; no code change needed in this PR.
Expected follow-up: Prefer a current-PR fix when local to changed code; defer only with rationale or linked follow-up.
Verification: Check PR feat(inference): add OpenRouter onboarding support #6461 diff against quickstart.mdx for overlapping lines
Missing regression test: N/A — merge coordination item
Done when: The local improvement is applied, or the PR notes why it should be deferred.
Evidence: pr_review_drift_context.openPrOverlaps shows PR feat(inference): add OpenRouter onboarding support #6461 with sameFiles: ['docs/get-started/quickstart.mdx']

Since last review details

Current findings, using the urgency labels above:

`PRA-1` Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

Location: docs/get-started/quickstart.mdx:1
Category: architecture
Problem: PR feat(inference): add OpenRouter onboarding support #6461 'feat(inference): add OpenRouter onboarding support' also modifies docs/get-started/quickstart.mdx. Both PRs touch the same file and may require conflict resolution on merge.
Impact: Potential merge conflicts if both PRs are merged without coordination. No code defect in this PR.
Suggested action: Coordinate with PR feat(inference): add OpenRouter onboarding support #6461 author to ensure clean merge; no code change needed in this PR.
Expected follow-up: Prefer a current-PR fix when local to changed code; defer only with rationale or linked follow-up.
Verification: Check PR feat(inference): add OpenRouter onboarding support #6461 diff against quickstart.mdx for overlapping lines
Missing regression test: N/A — merge coordination item
Done when: The local improvement is applied, or the PR notes why it should be deferred.
Evidence: pr_review_drift_context.openPrOverlaps shows PR feat(inference): add OpenRouter onboarding support #6461 with sameFiles: ['docs/get-started/quickstart.mdx']

Workflow run details

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.

github-actions · 2026-07-09T00:13:47Z

PR Review Advisor — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: No advisor follow-up required beyond maintainer review.
Open items: 0 required · 0 warnings · 0 suggestions · 0 test follow-ups
Since last review: 0 prior items resolved · 0 still apply · 0 new items found

Workflow run details

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.

github-code-quality · 2026-07-09T00:13:58Z

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage remains at 96%, unchanged from the main branch.

_{Updated July 09, 2026 00:29 UTC
Code Coverage is in Public Preview. Learn more and provide us with your feedback.}

## Summary Clarifies the OpenClaw quickstart non-interactive install guidance by linking directly to the provider selection section instead of referring to a provider table by relative position. ## Related Issue Fixes NVIDIA#5631 ## Changes - Update `docs/get-started/quickstart.mdx` to point readers to `Choose an Inference Provider` from the non-interactive install guidance. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates  - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: docs-only anchor wording change; no executable 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  - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run check:diff` passed when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: Tests not applicable; docs-only anchor wording change - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [x] `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) ---  Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>

docs: clarify quickstart non-interactive setup

e5fa52d

miyoungc added area: docs Documentation, examples, guides, or docs build area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow labels Jul 9, 2026

miyoungc self-assigned this Jul 9, 2026

miyoungc added 2 commits July 8, 2026 17:18

docs: point quickstart to provider section

b6697ee

Merge branch 'main' into codex/resolve-5631-quickstart-docs

e0d1a46

miyoungc added the v0.0.78 Release target label Jul 9, 2026

test: remove quickstart docs regression test

4c6b443

miyoungc mentioned this pull request Jul 9, 2026

[All Platforms][Docs] docs/get-started/quickstart.mdx — non-interactive onboard example missing required env vars; sandbox name inconsistency #5631

Closed

Merge branch 'main' into codex/resolve-5631-quickstart-docs

c630433

cv enabled auto-merge (squash) July 9, 2026 00:53

cv approved these changes Jul 9, 2026

View reviewed changes

cv merged commit 17bf9a6 into main Jul 9, 2026
32 checks passed

cv deleted the codex/resolve-5631-quickstart-docs branch July 9, 2026 00:54

Uh oh!

Conversation

miyoungc commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Changes

Type of Change

Quality Gates

Verification

Uh oh!

coderabbitai Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Advisor Recommendation

E2E Recommendation Advisor

Required E2E

Optional E2E

New E2E recommendations

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E Target Recommendation

E2E Target Advisor

Required E2E targets

Optional E2E targets

Relevant changed files

Uh oh!

github-actions Bot commented Jul 9, 2026

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Advisor (Nemotron Ultra) — No blocking findings

Action checklist

Findings index

⚠️ Resolve or justify before merge

💡 In-scope improvements

PRA-1 Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

PRA-1 Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Advisor — No blocking findings

Uh oh!

github-code-quality Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Overview

TypeScript / code-coverage/plugin

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

miyoungc commented Jul 9, 2026 •

edited

Loading

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading

github-actions Bot commented Jul 9, 2026 •

edited

Loading

github-actions Bot commented Jul 9, 2026 •

edited

Loading

github-actions Bot commented Jul 9, 2026 •

edited

Loading

`PRA-1` Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

`PRA-1` Improvement — Coordinate merge order with PR #6461 (OpenRouter onboarding support)

github-actions Bot commented Jul 9, 2026 •

edited

Loading

github-code-quality Bot commented Jul 9, 2026 •

edited

Loading