docs: add agent install prompt path - #6216
Conversation
|
🌿 Preview your docs: https://nvidia-preview-pr-6216.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
E2E Target RecommendationRequired E2E targets: None Full E2E target advisor summaryE2E Target AdvisorBase: Required E2E targets
Optional E2E targets
Relevant changed files
|
PR Review Advisor (Nemotron Ultra) — No blocking findingsMerge posture: No blocking advisor findings Action checklist
Findings index
Review findings by urgency: 0 required fixes, 0 items to resolve/justify, 1 in-scope improvement
|
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings Action checklist
Test follow-ups to resolve or justifyIf these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.
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. |
📝 WalkthroughWalkthroughThis PR centralizes the starter prompt into a shared component module, adds a manual-copy fallback, updates the prompt button to use the shared source, wires the fallback into docs entry points, and adds tests for the shared prompt and docs usage. ChangesStarter Prompt Component and Docs Integration
Estimated code review effort: 2 (Simple) | ~15 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
miyoungc
added
area: docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/get-started/quickstart-hermes.mdx (1)
29-31: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winTwo inaccuracies in this paragraph vs. the actual shared prompt content.
Same "AI Agent Docs" reference issue as in
docs/get-started/quickstart.mdx(line 26) —STARTER_PROMPTnever links toresources/agent-skills.Line 31 states the prompt "asks your agent to confirm Hermes as the selected agent," but
STARTER_PROMPTis the exact same generic string used on the OpenClaw quickstart, home, and agent-skills pages. Its "Choose My Agent and Docs Variant" section asks the user to pick between OpenClaw and Hermes — it doesn't already know or confirm Hermes. A Hermes-page reader may expect the copied prompt to skip that question, but it won't.Consider rewording to avoid implying Hermes-specific behavior that the shared prompt doesn't have, e.g. describing that the prompt will ask the user to select Hermes among the supported agents.
🤖 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-hermes.mdx` around lines 29 - 31, The quickstart copy in this page misstates what the shared STARTER_PROMPT does: it should not say the prompt points to AI Agent Docs or imply it already confirms Hermes. Update the paragraph to match the generic prompt used across the quickstarts by describing that it references the relevant docs in general and that the “Choose My Agent and Docs Variant” step asks the user to select Hermes (rather than assuming it is already selected). Keep the wording aligned with the STARTER_PROMPT content and the surrounding quickstart guidance.
🤖 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`:
- Around line 25-27: The quickstart copy overstates what the starter prompt
references, since STARTER_PROMPT in StarterPrompt.tsx does not include the
agent-skills page. Update the quickstart wording to match the actual
documentation-links list, or add the agent-skills link to STARTER_PROMPT so the
claim is accurate; use the STARTER_PROMPT documentation-links section and the
quickstart sentence as the main places to change.
---
Duplicate comments:
In `@docs/get-started/quickstart-hermes.mdx`:
- Around line 29-31: The quickstart copy in this page misstates what the shared
STARTER_PROMPT does: it should not say the prompt points to AI Agent Docs or
imply it already confirms Hermes. Update the paragraph to match the generic
prompt used across the quickstarts by describing that it references the relevant
docs in general and that the “Choose My Agent and Docs Variant” step asks the
user to select Hermes (rather than assuming it is already selected). Keep the
wording aligned with the STARTER_PROMPT content and the surrounding quickstart
guidance.
🪄 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: c5688746-e662-4e18-91cb-f156e128dcec
📒 Files selected for processing (6)
docs/_components/StarterPrompt.tsxdocs/_components/StarterPromptButton.tsxdocs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart.mdxdocs/index.mdxdocs/resources/agent-skills.mdx
| Copy the starter prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent when you want the assistant to install NemoClaw with you. | ||
| The prompt points your agent to [AI Agent Docs](../resources/agent-skills), this quickstart, the Markdown docs, and the optional `nemoclaw-user-guide` skill. | ||
| It also tells your agent to collect choices before launching interactive commands and to handle credentials outside the chat transcript. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Claim about "AI Agent Docs" isn't backed by the actual prompt text.
This states the prompt "points your agent to AI Agent Docs", but STARTER_PROMPT's documentation-links section (docs/_components/StarterPrompt.tsx, lines 60-68) only enumerates llms.txt and the OpenClaw/Hermes home, prerequisites, and quickstart pages — it never references resources/agent-skills. Readers may expect the copied prompt to route their agent to that page, but it won't.
Either update the sentence to describe what the prompt actually references, or add the agent-skills URL to STARTER_PROMPT's doc list so the claim is accurate.
🤖 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 25 - 27, The quickstart copy
overstates what the starter prompt references, since STARTER_PROMPT in
StarterPrompt.tsx does not include the agent-skills page. Update the quickstart
wording to match the actual documentation-links list, or add the agent-skills
link to STARTER_PROMPT so the claim is accurate; use the STARTER_PROMPT
documentation-links section and the quickstart sentence as the main places to
change.
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in the Show a code coverage summary of the most covered files.
TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most covered files.
Updated |
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 `@test/starter-prompt-docs.test.ts`:
- Around line 32-51: The starter prompt test is asserting raw source text
instead of observable behavior, so update the checks in
starter-prompt-docs.test.ts to exercise the public UI boundary. Replace the
grep-style expectations around StarterPromptFallback, StarterPromptButton, and
STARTER_PROMPT with rendering-based assertions that the copy button calls the
clipboard API with STARTER_PROMPT and that the fallback reveals the prompt text
in the DOM. For the MDX pages, use an MDX/render harness to verify the pages
actually render StarterPromptFallback and StarterPromptButton rather than
matching JSX strings.
🪄 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: 85c54a52-af7a-42a1-a8e7-1b3029a6b183
📒 Files selected for processing (2)
docs/_components/StarterPrompt.tsxtest/starter-prompt-docs.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/_components/StarterPrompt.tsx
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 `@README.md`:
- Line 27: The README wording is too restrictive by calling out “local coding
agent” even though the supported tools include agents that are not necessarily
local-only. Update the sentence in README.md to use a broader term like “coding
agent” or “agent” and keep the supported examples (Cursor, Claude Code, Codex,
Copilot) without implying locality.
🪄 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: c508e1fc-559c-49de-8379-669b45ee6cde
📒 Files selected for processing (1)
README.md
<!-- markdownlint-disable MD041 --> ## Summary Adds an agent-first install path to the NemoClaw docs front door and quickstarts so users can copy a prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent. The prompt now lives in one shared docs source, powers the copy button, and renders as a manual fallback for users whose browser or agent UI cannot use clipboard copy. ## Related Issue Fixes NVIDIA#5048 ## Changes - Added `docs/_components/StarterPrompt.tsx` as the shared source for the starter prompt plus a manual-copy fallback. - Updated `docs/_components/StarterPromptButton.tsx` to copy the shared prompt instead of embedding a duplicate prompt string. - Added the agent-supported install path near the top of the home page, OpenClaw quickstart, Hermes quickstart, and AI Agent Docs page. - Updated the prompt to tell agents to use NemoClaw skills when available and bootstrap `nemoclaw-user-guide` when missing. ## 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: docs-only CTA, prompt source, and docs-site component changes; no CLI/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) `npm run docs` passed with 0 errors; Fern reported the pre-existing light-mode accent color contrast warning. `fern check --warnings` confirmed the warning is unrelated to these docs content changes. --- <!-- 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> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a “Start from Your Coding Agent” flow across the getting-started docs and homepage onboarding. * Provided a copyable starter prompt experience with an in-UI manual copy fallback for clipboard-restricted environments. * **Documentation** * Updated quickstart and related guide pages with expanded, agent-friendly prompt instructions and behavior constraints (one question at a time, command approval, no secrets). * **Tests** * Added coverage to confirm prompt contents and validate the copy/manual fallback rendering across docs pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2 participants
Summary
Adds an agent-first install path to the NemoClaw docs front door and quickstarts so users can copy a prompt into Cursor, Claude Code, Codex, Copilot, or another local coding agent.
The prompt now lives in one shared docs source, powers the copy button, and renders as a manual fallback for users whose browser or agent UI cannot use clipboard copy.
Related Issue
Fixes #5048
Changes
docs/_components/StarterPrompt.tsxas the shared source for the starter prompt plus a manual-copy fallback.docs/_components/StarterPromptButton.tsxto copy the shared prompt instead of embedding a duplicate prompt string.nemoclaw-user-guidewhen missing.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)npm run docspassed with 0 errors; Fern reported the pre-existing light-mode accent color contrast warning.fern check --warningsconfirmed the warning is unrelated to these docs content changes.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit