docs(get-started): streamline quickstarts by miyoungc · Pull Request #6527 · NVIDIA/NemoClaw

miyoungc · 2026-07-09T00:54:53Z

Summary

Refactors the OpenClaw, Hermes, and Deep Agents quickstarts around four Fern Steps that take readers from installation to their first prompt.
Moves advanced deployment, recovery, and agent-specific detail into collapsed Considerations so the first-run procedure stays lightweight.

Changes

Replaced text-heavy OpenClaw, Hermes, and Deep Agents procedures with titled Fern <Steps> components.
Added collapsed Fern Accordion Considerations for automation, remote access, recovery, and day-two operations.
Kept Deep Agents runtime and trace-export guidance available on the same page without placing it in the first-run path.
Documented OpenClaw dashboard token URL handling and split Deep Agents operational details into focused accordions.
Preserved prior installer, platform, inference, integration, dashboard, API, and lifecycle reference details in expanded Considerations.

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: Documentation-only restructuring with no runtime behavior changes.
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 are not applicable to this documentation-only restructuring. npm run docs passed after the final updates.
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

Summary by CodeRabbit

Documentation
- Refreshed quickstart guides (OpenClaw, Hermes, and LangChain Deep Agents Code) with clearer front-matter and a guided “first prompt” flow.
- Reorganized onboarding/setup into accordion-based sections with step-by-step instructions, including readiness checks and selectable dashboard/CLI options.
- Expanded “Considerations” with consolidated automation/non-interactive setup, provider/inference guidance, and lifecycle/model management.
- Updated dashboard/terminal details, troubleshooting, and next steps (e.g., removed the “Monitor Sandbox Activity” link).

copy-pr-bot · 2026-07-09T00:54:56Z

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 · 2026-07-09T00:54:59Z

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: 735a1304-ecae-44a8-b07d-28da90278e17

📥 Commits

Reviewing files that changed from the base of the PR and between 854189f and a62d728.

📒 Files selected for processing (2)

docs/get-started/quickstart-langchain-deepagents-code.mdx
docs/get-started/quickstart.mdx

✅ Files skipped from review due to trivial changes (1)

docs/get-started/quickstart-langchain-deepagents-code.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

docs/get-started/quickstart.mdx

📝 Walkthrough

Walkthrough

Three quickstart documentation pages were revised: front-matter copy was shortened, onboarding was reorganized into setup and first-prompt flows, and the longer guidance was consolidated into accordion-based considerations and updated closing links.

Changes

Quickstart pages restructuring

Layer / File(s)	Summary
Hermes quickstart rewrite `docs/get-started/quickstart-hermes.mdx`	Front-matter copy, onboarding steps, consolidated considerations, and next-steps navigation were updated.
LangChain Deep Agents Code quickstart rewrite `docs/get-started/quickstart-langchain-deepagents-code.mdx`	Front-matter, onboarding/install flow, accordion subsection structure, trace export section, and closing accordion markup were updated.
OpenClaw quickstart rewrite `docs/get-started/quickstart.mdx`	Front-matter, setup/onboarding flow, considerations accordion, dashboard/terminal details, and troubleshooting/next-steps content were updated.

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

Suggested reviewers: prekshivyas, jyaunches

🚥 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 is concise and matches the main change: streamlining the get-started quickstart docs.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch codex/restructure-get-started-quickstarts

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

…ure-get-started-quickstarts # Conflicts: # docs/get-started/quickstart.mdx

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

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 quickstart content changes cannot affect NemoClaw runtime behavior or existing E2E-covered user flows. The deterministic risk plan has no required jobs, so no E2E is recommended for this PR.

Optional E2E

None.

New E2E recommendations

None.

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

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

github-actions · 2026-07-09T00:57:58Z

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 changes under docs/get-started cannot affect E2E target workflow behavior.

Optional E2E targets

None.

Relevant changed files

None.

github-actions · 2026-07-09T01:00:07Z

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-actions · 2026-07-09T01:00:12Z

PR Review Advisor (Nemotron Ultra) — 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.

miyoungc · 2026-07-09T01:03:35Z

Addressed the automated review findings in 35b666f5d.

OpenClaw now states that its complete dashboard URL contains the gateway token fragment used for browser authentication, and that the URL must be treated as a password.
The Deep Agents Considerations section now uses focused accordions for onboarding, runtime behavior, Python and state, Tavily egress, and trace export.
The non-interactive installer warning about placing NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1 on the bash side of the pipe is present in the automation accordion.
The branch was updated with git pull origin main --no-rebase; the only conflict was the merged main clarification for non-interactive provider credentials, which is preserved in the automation accordion.
Ran npm run docs after the final updates. The pinned docs gate, generated-variant check, and published-route check all passed.

The draft PR's CodeRabbit review is intentionally skipped by repository configuration. The future merge conflicts mentioned for other open PRs are branch-management work for those PRs when they rebase onto main; this branch is current with origin/main.

miyoungc · 2026-07-09T01:43:28Z

Reviewed the latest PR Review Advisor reports for the current head. I am retaining the present documentation structure for the following reasons.

Component validation: npm run docs completed successfully on the current head, including generated-variant and route validation. Fern reported zero errors and one non-failing warning, so I will not claim a warning-free run without an identified warning to fix. A source rewrite or runtime tests are not warranted for this documentation-only MDX change.
Merge conflicts: this branch is current with origin/main. Potential conflicts with other open documentation PRs require normal ordered merging or rebasing when those branches land, not speculative edits here.
Hermes non-interactive examples: exported variables are inherited by the installer shell, so the documented examples work. Changing the placement does not eliminate shell-history or child-process environment exposure.
Deep Agents CI example: adding unverified non-interactive configuration is outside this restructuring scope.
Accordion headings and scope: the headings preserve navigation within detailed Considerations, while the first-run procedure remains lightweight. The OTLP material stays in this page because the requested structure keeps detailed guidance in same-page Considerations.
OTLP anchor: the explicit export-traces-through-a-local-collector anchor is referenced by the commands, network-policy, and credential-storage documentation. Removing it would break those links.
Accordion consolidation: the concise and detailed non-interactive, onboarding, and platform sections serve distinct reader tasks. Further consolidation risks losing the specific operational detail preserved in this PR.

No source change is needed for these suggestions.

Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>

cjagwani · 2026-07-09T14:24:57Z

Exact-head docs-render validation for a62d72839eafdc63728bf921b550d89b96a7f03e:

npm run docs passed: agent-variant checks and route checks passed, and pinned Fern validation reported 0 errors. Its two warnings are outside the changed files: the unauthenticated redirects check and the existing light-mode accent contrast.
All three Fern preview pages return 200. Rendered HTML preserves the intended component structure exactly: OpenClaw 4 Steps / 9 accordions, Hermes 4 / 9, and Deep Agents 4 / 5.
All three generated .md routes return 200 as text/markdown. Fern flattens component labels in Markdown, but every nested Step and Accordion body boundary survived: OpenClaw 26/26 probes, Hermes 26/26, and Deep Agents 18/18.
Security-sensitive guidance is present in both HTML and Markdown: the OpenClaw gateway-token and recovery-warning guidance; Hermes dashboard/API and no-OpenClaw-token guidance; and Deep Agents private receiver binding, credential boundary, unauthenticated trace-submission warning, and managed-runtime guidance.

Validated routes:

cjagwani

Approved exact head a62d72839eafdc63728bf921b550d89b96a7f03e: current main was synced mechanically, npm run docs passed, Fern HTML and generated Markdown preserved the nested quickstart and security guidance, all 41 checks are green, CodeRabbit has no actionable findings, both trusted advisors report merge_as_is, and DCO plus GitHub verification pass for every commit.

## Summary Adds the pre-tag v0.0.79 release notes entry to `docs/about/release-notes.mdx` so the release plan can be generated after docs merge. The entry summarizes the merged v0.0.79 release train across inference, diagnostics, runtime hardening, policies, onboarding recovery, and release validation. ## Changes - Added the v0.0.79 release notes section with linked follow-up documentation for OpenRouter onboarding, managed vLLM changes, completion and logging, Deep Agents runtime limits, policy updates, onboarding recovery, and release validation. - Source summary: - #6461 -> `docs/about/release-notes.mdx`: Documents OpenRouter onboarding support and links to inference/provider references. - #6271 and #6272 -> `docs/about/release-notes.mdx`: Documents shell completion and structured logging highlights. - #6465, #6539, #6570, and #6528 -> `docs/about/release-notes.mdx`: Documents status route-drift, orphaned sandbox, gateway cleanup, and DGX Spark express-install diagnostics. - #6523, #6551, #6484, #6488, #6324, and #6542 -> `docs/about/release-notes.mdx`: Documents managed vLLM, Qwen3.6 tool parser, compaction, and timeout/readiness improvements. - #6559, #6538, #6560, #6568, #6552, #6567, and #6587 -> `docs/about/release-notes.mdx`: Documents runtime, credential, proxy, PID namespace, TOML, and provider-state hardening. - #6541, #5415, #6246, #6496, and #6573 -> `docs/about/release-notes.mdx`: Documents GitHub policy, Gmail policy, MCP allowlist, WhatsApp, and messaging-variant updates. - #6253, #6572, #6444, #6536, and #5860 -> `docs/about/release-notes.mdx`: Documents onboarding resume and create-step recovery improvements. - #6508, #6527, #5506, #6588, #6446, #6447, #6582, #6296, #6367, #6397, and #6505 -> `docs/about/release-notes.mdx`: Documents docs, release-risk, and E2E validation updates. ## 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: Release-note prose only. - [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, release-note prose only. - [ ] 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 - [ ] `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) Docs validation note: `npm run docs:check-agent-variants && npm run docs:check-routes && git diff --check` passed. Full `npm run docs` is currently blocked before Fern validation because the pinned `fern-api@5.65.2` package is unavailable from npm (`ETARGET No matching version found`). ---  Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>  ## Summary by CodeRabbit * **Documentation** * Added release notes for v0.0.79 with a new summary of recent improvements, including onboarding and inference options, operator/CLI diagnostics, sandbox recovery hardening, runtime limits, network policy behavior, and release validation updates. * Added updated references and links for the latest release.

## Summary Adds the pre-tag v0.0.79 release notes entry to `docs/about/release-notes.mdx` so the release plan can be generated after docs merge. The entry summarizes the merged v0.0.79 release train across inference, diagnostics, runtime hardening, policies, onboarding recovery, and release validation. ## Changes - Added the v0.0.79 release notes section with linked follow-up documentation for OpenRouter onboarding, managed vLLM changes, completion and logging, Deep Agents runtime limits, policy updates, onboarding recovery, and release validation. - Source summary: - NVIDIA#6461 -> `docs/about/release-notes.mdx`: Documents OpenRouter onboarding support and links to inference/provider references. - NVIDIA#6271 and NVIDIA#6272 -> `docs/about/release-notes.mdx`: Documents shell completion and structured logging highlights. - NVIDIA#6465, NVIDIA#6539, NVIDIA#6570, and NVIDIA#6528 -> `docs/about/release-notes.mdx`: Documents status route-drift, orphaned sandbox, gateway cleanup, and DGX Spark express-install diagnostics. - NVIDIA#6523, NVIDIA#6551, NVIDIA#6484, NVIDIA#6488, NVIDIA#6324, and NVIDIA#6542 -> `docs/about/release-notes.mdx`: Documents managed vLLM, Qwen3.6 tool parser, compaction, and timeout/readiness improvements. - NVIDIA#6559, NVIDIA#6538, NVIDIA#6560, NVIDIA#6568, NVIDIA#6552, NVIDIA#6567, and NVIDIA#6587 -> `docs/about/release-notes.mdx`: Documents runtime, credential, proxy, PID namespace, TOML, and provider-state hardening. - NVIDIA#6541, NVIDIA#5415, NVIDIA#6246, NVIDIA#6496, and NVIDIA#6573 -> `docs/about/release-notes.mdx`: Documents GitHub policy, Gmail policy, MCP allowlist, WhatsApp, and messaging-variant updates. - NVIDIA#6253, NVIDIA#6572, NVIDIA#6444, NVIDIA#6536, and NVIDIA#5860 -> `docs/about/release-notes.mdx`: Documents onboarding resume and create-step recovery improvements. - NVIDIA#6508, NVIDIA#6527, NVIDIA#5506, NVIDIA#6588, NVIDIA#6446, NVIDIA#6447, NVIDIA#6582, NVIDIA#6296, NVIDIA#6367, NVIDIA#6397, and NVIDIA#6505 -> `docs/about/release-notes.mdx`: Documents docs, release-risk, and E2E validation updates. ## 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: Release-note prose only. - [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, release-note prose only. - [ ] 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 - [ ] `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) Docs validation note: `npm run docs:check-agent-variants && npm run docs:check-routes && git diff --check` passed. Full `npm run docs` is currently blocked before Fern validation because the pinned `fern-api@5.65.2` package is unavailable from npm (`ETARGET No matching version found`). ---  Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>  ## Summary by CodeRabbit * **Documentation** * Added release notes for v0.0.79 with a new summary of recent improvements, including onboarding and inference options, operator/CLI diagnostics, sandbox recovery hardening, runtime limits, network policy behavior, and release validation updates. * Added updated references and links for the latest release.

docs(get-started): streamline quickstarts

4dd08c9

miyoungc added the area: docs Documentation, examples, guides, or docs build label Jul 9, 2026

miyoungc self-assigned this Jul 9, 2026

Merge branch 'main' of github.com:NVIDIA/NemoClaw into codex/restruct…

42342d3

…ure-get-started-quickstarts # Conflicts: # docs/get-started/quickstart.mdx

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

docs(get-started): clarify quickstart considerations

35b666f

miyoungc added 5 commits July 8, 2026 18:06

docs(get-started): title case quickstart steps

e92a80b

docs(get-started): preserve quickstart details

fd3b4e9

docs(get-started): move starter prompts

296ccf4

docs(get-started): title quickstart setup paths

a7697c6

docs(get-started): clarify quickstart setup paths

854189f

miyoungc marked this pull request as ready for review July 9, 2026 01:34

merge(docs): sync quickstarts with main

a62d728

Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>

cjagwani approved these changes Jul 9, 2026

View reviewed changes

miyoungc merged commit 9cfce7a into main Jul 9, 2026
45 checks passed

miyoungc deleted the codex/restructure-get-started-quickstarts branch July 9, 2026 14:42

jyaunches mentioned this pull request Jul 9, 2026

docs: prepare v0.0.79 release notes #6594

Merged

21 tasks

Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026

docs(get-started): streamline quickstarts (NVIDIA#6527)

b7fa814

Uh oh!

Conversation

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

Uh oh!

Summary

Changes

Type of Change

Quality Gates

Verification

Summary by CodeRabbit

Uh oh!

copy-pr-bot Bot commented Jul 9, 2026

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

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 • 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-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

Uh oh!

miyoungc commented Jul 9, 2026

Uh oh!

miyoungc commented Jul 9, 2026

Uh oh!

cjagwani commented Jul 9, 2026

Uh oh!

cjagwani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

miyoungc commented Jul 9, 2026 •

edited by coderabbitai Bot

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

github-actions Bot commented Jul 9, 2026 •

edited

Loading