docs: explain onboard fresh flag#4433
Conversation
Signed-off-by: Omri SirComp <omribz156@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds a documentation note to the ChangesCLI Documentation
Sequence Diagram(s)sequenceDiagram
participant Reader
participant commands_mdx as docs/reference/commands.mdx
participant CLIHelp as "nemoclaw onboard --help"
Reader->>commands_mdx: reads `--fresh` explanation
CLIHelp->>Reader: provides same `--fresh` synopsis
commands_mdx->>Reader: clarifies `--fresh` restarts wizard (not resume)
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
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 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/reference/commands.mdx (1)
74-74: ⚡ Quick winSplit the two sentences into separate source lines.
Line 74 has two sentences on the same line; keep one sentence per line for docs diffs/readability.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 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 74, The documentation sentence on the same line should be split into two source lines: put "Use `--fresh` to ignore any saved onboarding session and restart the wizard from scratch." on its own line and then place "This is useful after an interrupted `nemoclaw onboard` run when you want to discard saved state instead of continuing it with `--resume`." on the next line so each sentence is on a separate source line.
🤖 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.
Nitpick comments:
In `@docs/reference/commands.mdx`:
- Line 74: The documentation sentence on the same line should be split into two
source lines: put "Use `--fresh` to ignore any saved onboarding session and
restart the wizard from scratch." on its own line and then place "This is useful
after an interrupted `nemoclaw onboard` run when you want to discard saved state
instead of continuing it with `--resume`." on the next line so each sentence is
on a separate source line.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b8ebe71b-60fe-456f-beeb-deee92b670e0
📒 Files selected for processing (1)
docs/reference/commands.mdx
|
✨ Thanks for submitting this detailed PR that explains the onboard fresh flag in the reference docs, which proposes a way to improve documentation clarity by adding a missing explanation for the --fresh synopsis flag. This update adds prose to the onboard command documentation to match the existing synopsis flag. Related open issues: |
|
Actionable comments posted: 0 |
Summary
Add the missing
--freshexplanation to thenemoclaw onboardreference docs so the synopsis flag has matching prose.Related Issue
Fixes #4418
Changes
--freshrestarts onboarding from scratch and discards saved onboarding state instead of resuming it.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Additional local checks:
git diff --checkrg -n -- "Use--fresh|--fresh|--resume" docs/reference/commands.mdxNot run: full docs build/test suite; this is a one-line prose-only docs update.
This was implemented with Codex assistance, with the patch kept focused and manually reviewed.
Signed-off-by: Omri SirComp omribz156@gmail.com
Summary by CodeRabbit
--freshflag for thenemoclaw onboardcommand discards any saved onboarding session state and restarts the interactive onboarding wizard from the beginning after an interrupted run, ensuring a clean onboarding session when used.