docs: add nemoclaw debug command to CLI reference and troubleshooting#882
Open
clark-s-dev wants to merge 2 commits intoNVIDIA:mainfrom
Open
docs: add nemoclaw debug command to CLI reference and troubleshooting#882clark-s-dev wants to merge 2 commits intoNVIDIA:mainfrom
clark-s-dev wants to merge 2 commits intoNVIDIA:mainfrom
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughDocumented a new CLI subcommand Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/reference/troubleshooting.md (1)
27-29: Use a nativetipadmonition directive instead of genericadmonition+ class.This callout should use MyST
:::{tip}directly for consistency with the docs style.As per coding guidelines, "Use MyST admonitions (:::{tip}, :::{note}, :::{warning}) for callouts, not bold text or blockquotes."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` around lines 27 - 29, Replace the generic MyST admonition block that uses ":::{admonition} :class: tip" with the native MyST admonition directive ":::{tip}" directly; locate the block around the "Collect diagnostics first" callout and change its opening marker to "::: {tip}" (i.e., use the MyST tip admonition) and ensure the closing marker remains the matching ":::".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/commands.md`:
- Around line 175-177: The description line that currently states "secrets
automatically redacted" overstates the behavior; update the command's
documentation string (the sentence in the diagnostics command description) to
say that known sensitive patterns are redacted or that automated redaction is
applied to common secrets, and explicitly advise users to review the output for
any remaining sensitive data so the text matches the implementation's behavior.
In `@docs/reference/troubleshooting.md`:
- Around line 30-31: The docs claim the report is redacted but the debug tool
(nemoclaw debug) / scripts/debug.sh only applies pattern-based redaction and
warns manual review; update the troubleshooting text to avoid implying full
secret scrubbing by changing the sentence to state the report is "partially
redacted" or "redacted for known patterns" and explicitly instruct users to
manually review and remove any sensitive data before sharing (retain the example
with `nemoclaw debug --output ...` and the GitHub issue link).
---
Nitpick comments:
In `@docs/reference/troubleshooting.md`:
- Around line 27-29: Replace the generic MyST admonition block that uses
":::{admonition} :class: tip" with the native MyST admonition directive
":::{tip}" directly; locate the block around the "Collect diagnostics first"
callout and change its opening marker to "::: {tip}" (i.e., use the MyST tip
admonition) and ensure the closing marker remains the matching ":::".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 70e57225-73d3-4b7d-afce-971df7c92db6
📒 Files selected for processing (2)
docs/reference/commands.mddocs/reference/troubleshooting.md
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
2 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
Related Issue
Changes
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
update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docscatch up the docs for the new changes I made in this PR."Summary by CodeRabbit