docs(reference,quickstart): explain --fresh/--yes and the curl|bash flag form#3351
docs(reference,quickstart): explain --fresh/--yes and the curl|bash flag form#3351latenighthackathon wants to merge 1 commit into
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds ChangesNemoClaw CLI Onboarding Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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)
Comment |
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 @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Around line 173-179: The synopsis near the top of the document is missing the
new `--yes`/`-y` flag; update the synopsis line that lists flags to include
`[--yes | -y]` (matching the detailed section titled "`--yes` / `-y`") so the
top-of-page synopsis and the detailed flag description stay consistent.
🪄 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: c33219f4-8429-4e43-9f79-792e8d406c2c
📒 Files selected for processing (3)
.agents/skills/nemoclaw-user-reference/references/commands.mddocs/get-started/quickstart.mddocs/reference/commands.md
082535a to
9c84b54
Compare
|
✨ Thanks for submitting this detailed PR to address documentation gaps for the --fresh, --yes, and --resume flags in the NemoClaw onboard command. This change aims to improve the accuracy of the documentation by explaining the default resume-saved-session behavior and clarifying the failure mode if no saved session exists for --resume. Related open issues: |
8a80caa to
06a54b1
Compare
06a54b1 to
b0c7ea8
Compare
5efe978 to
7da6bd4
Compare
…lag form Two related doc gaps reported in the same week. Closes NVIDIA#3275: the quickstart already showed the env-var form for accepting the third-party software notice when piping `curl` into `bash`, but did not show the flag form (`bash -s -- --yes-i-accept-third-party-software`) that `install.sh --help` documents. Add a second example next to the env form and a one-sentence note that piping `curl` into `bash` strips the TTY so explicit acceptance is required. Closes NVIDIA#3233 (partial): adds `#### --fresh and --resume` and `#### --yes / -y` flag subsections to `### nemoclaw onboard` in `docs/reference/commands.md`, mirroring the existing `#### --from <Dockerfile>` subsection pattern. Explains the default-resume behavior, contrasts `--fresh` against `--resume` (mutually exclusive), and clarifies that `--yes` does not bypass the third-party software notice. The remaining two complaints in NVIDIA#3233 are stale on current main: `--probe-only` is documented at commands.md:308 and `--yes` is in the onboard synopsis at line 68. Mirrored to the nemoclaw-user-reference skill. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
7da6bd4 to
0116083
Compare
|
Closing in favor of #4167 which is rebuilt cleanly on current upstream/main with the same content. Cheers! |
…lag form (closes NVIDIA#3233, NVIDIA#3275) Three small documentation additions in the same area: `docs/reference/commands.mdx` gains two new subsections under the `nemoclaw onboard` reference, between the `--reuse-health` block and the `--from <Dockerfile>` block: - `--fresh` and `--resume` — explains the default resume-saved-session behavior, the `--fresh` opt-out, the `--resume` "must-exist" form, and the mutual exclusion. - `--yes` / `-y` — explains auto-confirm semantics, the `NEMOCLAW_YES=1` equivalent, and the explicit carve-out for the third-party software notice. `docs/get-started/quickstart.mdx` clarifies that piping `curl` into `bash` strips the TTY, then documents both non-interactive forms: either env-var prefix on `bash`, or the flag form via `bash -s -- --yes-i-accept-third-party-software`. The synopsis line at the top of the onboard section was already updated upstream to include `[--yes | -y]`, so no synopsis change is needed in the fresh version. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py`. This is a fresh recreation of the closed NVIDIA#3351 rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Summary
Two related doc gaps reported in the same week. Adds an
### nemoclaw onboardflag-explainer block for--fresh/--resume/--yesto the commands reference, and adds thebash -s -- --yes-i-accept-third-party-softwareflag form to the quickstart curl|bash example.Related Issue
Closes #3275. Closes #3233 (partial, see verification notes).
Changes
docs/reference/commands.mdx: new#### --fresh and --resumesubsection mirroring the existing#### --from <Dockerfile>pattern. Explains the default resume-saved-session behavior, contrasts--freshagainst--resume(mutually exclusive), and clarifies the failure mode if no saved session exists for--resume. Also adds a#### --yes / -ysubsection clarifying that--yesis for safe-for-unattended prompts and is not equivalent to--yes-i-accept-third-party-softwarefor the licensing notice.docs/get-started/quickstart.mdx: adds thebash -s -- --yes-i-accept-third-party-softwareflag form alongside the existing env-var form, plus a one-sentence note that pipingcurlintobashstrips the TTY so explicit acceptance is required..agents/skills/nemoclaw-user-reference/references/commands.md: same#### --fresh and --resumeand#### --yes / -ysubsections added to keep the auto-generated skill in sync. The onboard synopsis at the top of the file already lists[--yes | -y].Test plan
prek runcleannemoclaw onboard --helpoutput for the flag names + descriptionsSigned-off-by: latenighthackathon latenighthackathon@users.noreply.github.com