docs: update onboarding quickstarts#4451
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis pull request updates NemoClaw's onboarding documentation across three files to address gaps in Hermes prerequisites, non-TTY installation guidance, and wizard flow descriptions. Changes add Docker setup requirements for Hermes, remote access configuration via CHAT_UI_URL, clarify third-party acceptance for piped installs, synchronize wizard flow across docs, and document previously undocumented CLI flags. ChangesNemoClaw Onboarding Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-4451.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/get-started/quickstart-hermes.mdx (1)
23-23: ⚡ Quick winUse active voice and direct second-person phrasing in reader instructions.
Line 23 uses passive construction, and Line 39 addresses “a headless host” instead of directly addressing the reader. Please rewrite both lines in active voice with “you.”
As per coding guidelines, "Active voice required." and "Second person ('you') when addressing the reader."
Also applies to: 39-39
🤖 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` at line 23, Rewrite the two passive sentences to active second-person phrasing: change "Docker must be installed, running, and reachable from the current shell before Hermes onboarding can build the sandbox image." to something like "You must install Docker, start it, and ensure it’s reachable from your shell before Hermes onboarding builds the sandbox image." Also replace the "a headless host" phrasing (the sentence around Line 39) with direct "you" addressing (e.g., "If you are on a headless host, ...") so both sentences use active voice and second person.docs/reference/commands.mdx (1)
103-103: ⚡ Quick winRemove unnecessary bold emphasis on routine prose.
**policy tier**reads as emphasis rather than a UI label or warning; use plain text here to match docs style consistency.As per coding guidelines, “Unnecessary bold on routine instructions … Bold is reserved for UI labels, parameter names, and genuine warnings.”
🤖 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/reference/commands.mdx` at line 103, Remove the unnecessary bold markup around the phrase "**policy tier**" in the documentation sentence so it reads as plain text "policy tier"; locate the string "**policy tier**" in the docs/reference/commands.mdx content and replace the bolded markup with unformatted text to match the project's style guidelines for routine instructions and UI label usage.
🤖 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-hermes.mdx`:
- Around line 43-47: Update the command-only fenced block in
quickstart-hermes.mdx to be a copyable shell snippet: replace the
triple-backtick "console" fence with "bash" (or "sh"), remove leading "$" prompt
markers from each line so the three lines are plain commands, and ensure the
closing triple-backticks remain; locate the block containing NEMOCLAW_AGENT,
CHAT_UI_URL, and the curl command to apply this change.
---
Nitpick comments:
In `@docs/get-started/quickstart-hermes.mdx`:
- Line 23: Rewrite the two passive sentences to active second-person phrasing:
change "Docker must be installed, running, and reachable from the current shell
before Hermes onboarding can build the sandbox image." to something like "You
must install Docker, start it, and ensure it’s reachable from your shell before
Hermes onboarding builds the sandbox image." Also replace the "a headless host"
phrasing (the sentence around Line 39) with direct "you" addressing (e.g., "If
you are on a headless host, ...") so both sentences use active voice and second
person.
In `@docs/reference/commands.mdx`:
- Line 103: Remove the unnecessary bold markup around the phrase "**policy
tier**" in the documentation sentence so it reads as plain text "policy tier";
locate the string "**policy tier**" in the docs/reference/commands.mdx content
and replace the bolded markup with unformatted text to match the project's style
guidelines for routine instructions and UI label usage.
🪄 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: a9c9da09-267c-4939-88ce-6ed5ce705508
📒 Files selected for processing (3)
docs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart.mdxdocs/reference/commands.mdx
Comment on lines
+43
to
+47
| ```console | ||
| $ export NEMOCLAW_AGENT=hermes | ||
| $ export CHAT_UI_URL="https://hermes.example.com:8642" | ||
| $ curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash | ||
| ``` |
Contributor
There was a problem hiding this comment.
Use a copyable shell code block format for command-only examples.
This block is copyable commands, so it should be tagged bash/sh and omit $ prompt markers instead of using console.
Suggested diff
-```console
-$ export NEMOCLAW_AGENT=hermes
-$ export CHAT_UI_URL="https://hermes.example.com:8642"
-$ curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash
-```
+```bash
+export NEMOCLAW_AGENT=hermes
+export CHAT_UI_URL="https://hermes.example.com:8642"
+curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash
+```As per coding guidelines, "Copyable CLI code blocks must use language-specific tags such as bash, sh, or powershell, and must not include prompt markers such as $."
🤖 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 43 - 47, Update the
command-only fenced block in quickstart-hermes.mdx to be a copyable shell
snippet: replace the triple-backtick "console" fence with "bash" (or "sh"),
remove leading "$" prompt markers from each line so the three lines are plain
commands, and ensure the closing triple-backticks remain; locate the block
containing NEMOCLAW_AGENT, CHAT_UI_URL, and the curl command to apply this
change.
cv
approved these changes
May 28, 2026
Contributor
PR Review AdvisorFindings: 1 needs attention, 1 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
This is an automated advisory review. A human maintainer must make the final merge decision. |
2 tasks
This was referenced May 29, 2026
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
3 participants
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
Update the onboarding docs for the current v0.0.53 flow so users see the correct installer, quickstart, and Hermes setup guidance.
Related Issue
Fixes #4418
Fixes #4417
Fixes #4413
Fixes #4412
Changes
nemoclaw onboard --resumeand--freshguidance to the command reference.CHAT_UI_URLguidance for exposing the Hermes API on port8642.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Notes:
npm run docscompleted with 0 errors and 1 existing Fern theme contrast warning.npx prek run --all-filesfailed in unrelated existing CLI/e2e tests: two test timeouts and one sandbox connect assertion.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit
--resumeand--freshflags for resumable and fresh onboarding runs