docs(commands): align onboard usage synopsis with CLI output - #1783
Conversation
Signed-off-by: nihalmaddala <nihalmaddala@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates synchronize two CLI reference files so the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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 |
|
✨ Thanks for submitting this PR, which proposes a way to improve the accuracy of the onboard usage synopsis in the command reference. Possibly related open issues: |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
…1783) ## Summary Updates the `nemoclaw onboard` usage synopsis in the command reference so it matches the live CLI usage output. Includes the generated skill reference update produced by the docs-to-skills pipeline. ## Related Issue Fixes NVIDIA#1730 ## Changes - Updates `docs/reference/commands.md` onboarding usage synopsis to include `--dangerously-skip-permissions` in addition to the already-added non-experimental flags. - Updates generated skill mirror: `.agents/skills/nemoclaw-user-reference/references/commands.md`. ## Type of Change - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [x] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing - [ ] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [x] `make docs` builds without warnings. (for doc-only changes) ## Checklist ### General - [x] I have read and followed the [contributing guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md). - [x] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes - [ ] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs). - [ ] Tests added or updated for new or changed behavior. - [x] No secrets, API keys, or credentials committed. - [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). ### Doc Changes - [x] Follows the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). Try running the `nemoclaw-contributor-update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/nemoclaw-contributor-update-docs` catch up the docs for the new changes I made in this PR." - [x] New pages include SPDX license header and frontmatter, if creating a new page. - [x] Cross-references and links verified. --- Signed-off-by: nihalmaddala <nihalmaddala@gmail.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated the nemoclaw onboard command reference across documentation to list additional CLI flags: --recreate-sandbox, --agent <name>, --dangerously-skip-permissions, and --yes-i-accept-third-party-software. * Clarified the documented command usage so users can see the expanded set of available flags in user-facing references. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: nihalmaddala <nihalmaddala@gmail.com> Co-authored-by: Prekshi Vyas <34834085+prekshivyas@users.noreply.github.com> Signed-off-by: ColinM-sys <cmcdonough@50words.com>
Summary
Updates the
nemoclaw onboardusage synopsis in the command reference so it matches the live CLI usage output.Includes the generated skill reference update produced by the docs-to-skills pipeline.
Related Issue
Fixes #1730
Changes
docs/reference/commands.mdonboarding usage synopsis to include--dangerously-skip-permissionsin addition to the already-added non-experimental flags..agents/skills/nemoclaw-user-reference/references/commands.md.Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Code Changes
npx prek run --all-filesauto-fixes formatting (ormake formatfor targeted runs).Doc Changes
nemoclaw-contributor-update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/nemoclaw-contributor-update-docscatch up the docs for the new changes I made in this PR."Signed-off-by: nihalmaddala nihalmaddala@gmail.com
Summary by CodeRabbit