docs: refresh doc and start collecting troubleshooting items in a singular place#331
Merged
docs: refresh doc and start collecting troubleshooting items in a singular place#331
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 (3)
📝 WalkthroughWalkthroughAdded a new Troubleshooting reference page and linked it from the docs navigation and README; removed the duplicated Common Issues section from a monitoring doc; updated command reference and onboarding/preflight messaging (RFC 1123 sandbox naming, cgroup v2 Docker checks, host-side sandbox inspection guidance), and added PATH remediation notes for nvm/fnm users. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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)
📝 Coding Plan
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: 1
🤖 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 66-69: Replace the incorrect CLI invocation "openshell sandbox
status" with the correct command "openshell sandbox list" wherever it appears in
the docs (specifically update the sentence that currently reads 'Run `openshell
sandbox status` on the host for full details.' and the troubleshooting entry
that references the status command); search for the exact string "openshell
sandbox status" and change it to "openshell sandbox list", and update any
surrounding wording if needed to match the README usage.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ffc0e2e4-5320-403e-b459-50480e0ae0bd
📒 Files selected for processing (5)
README.mddocs/index.mddocs/monitoring/monitor-sandbox-activity.mddocs/reference/commands.mddocs/reference/troubleshooting.md
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/reference/commands.md (1)
66-68:⚠️ Potential issue | 🟡 MinorCorrect the OpenShell command per previous review.
The command
openshell sandbox statuson line 68 is not valid. According to the previous review verification, the correct command isopenshell sandbox listfor checking sandbox state on the host.🔧 Proposed fix
When running inside an active OpenShell sandbox, the status command detects the sandbox context and reports "active (inside sandbox)" instead of false negatives. Host-side sandbox state and inference configuration are not inspectable from inside the sandbox. -Run `openshell sandbox status` on the host for full details. +Run `openshell sandbox list` on the host for full details.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` around lines 66 - 68, Update the documentation text that instructs users to run the host-side command: replace the incorrect command string "openshell sandbox status" with the correct "openshell sandbox list" wherever it appears (the sentence that currently reads "Run `openshell sandbox status` on the host for full details." should instead read "Run `openshell sandbox list` on the host for full details."); ensure the example/description around sandbox status detection and host inspection remains unchanged except for this command correction.docs/reference/troubleshooting.md (1)
92-92:⚠️ Potential issue | 🟡 MinorCorrect the OpenShell command per previous review.
The command
openshell sandbox statusis not valid. According to the previous review verification, the correct command isopenshell sandbox listfor checking sandbox state.🔧 Proposed fix
-Run `openshell sandbox status` on the host for full details. +Run `openshell sandbox list` on the host for full details.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` at line 92, Replace the invalid command invocation "openshell sandbox status" with the correct command "openshell sandbox list" in the docs; update the text line that currently reads Run `openshell sandbox status` to instead read Run `openshell sandbox list` so the troubleshooting instructions point to the valid command for checking sandbox state.
🧹 Nitpick comments (3)
docs/reference/troubleshooting.md (3)
64-64: Clarify which DNS is propagating.The phrase "gateway's DNS has not finished propagating" is vague. Consider specifying what DNS records or service discovery mechanism needs to propagate (e.g., internal service mesh DNS, gateway endpoint registration).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` at line 64, Update the sentence "gateway's DNS has not finished propagating" in troubleshooting.md to specify exactly which DNS or registration must propagate (e.g., internal service mesh DNS records, gateway endpoint A/AAAA/CNAME entries, or gateway endpoint registration in service discovery), and give a brief example such as "the gateway's internal service mesh DNS record or external gateway endpoint A/CNAME record has not finished propagating" so readers know whether to check service-mesh DNS, external DNS entries, or gateway registration.
37-37: Simplify the platform description.The phrasing "Linux Ubuntu 22.04 LTS or later" is redundant since Ubuntu is inherently a Linux distribution.
✏️ Suggested revision
-NemoClaw requires Linux Ubuntu 22.04 LTS or later. +NemoClaw requires Ubuntu 22.04 LTS or later.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` at line 37, Replace the redundant platform phrase "Linux Ubuntu 22.04 LTS or later" in the troubleshooting text with a simplified statement such as "Ubuntu 22.04 LTS or later" (or, if you want to keep OS family, "Linux (Ubuntu 22.04 LTS or later)") so the platform requirement is clear and not repetitive; update the sentence at the same location where the current line reads "NemoClaw requires Linux Ubuntu 22.04 LTS or later." to the chosen simplified phrasing.
50-51: Optional: MD014 markdownlint warnings about console prompt style.Static analysis flags the
$prompts in console blocks without showing command output (MD014). This is typically a stylistic choice in documentation. If the project prefers showing only commands (without output), these warnings can be safely ignored. If output examples would help users, consider adding representative output after the commands.Also applies to: 76-76, 100-100, 111-111, 122-122
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/troubleshooting.md` around lines 50 - 51, Remove or fix MD014 warnings in the console code blocks by either (a) removing the leading "$ " prompt from the shown commands (e.g., "sudo nemoclaw setup-spark" and "nemoclaw onboard") so only the commands remain, (b) adding representative command output lines immediately after each command to justify keeping the "$ " prompt, or (c) disabling the rule for those blocks with an inline markdownlint directive. Update the affected blocks in docs/reference/troubleshooting.md accordingly so the markdown linter no longer flags MD014.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/reference/commands.md`:
- Around line 66-68: Update the documentation text that instructs users to run
the host-side command: replace the incorrect command string "openshell sandbox
status" with the correct "openshell sandbox list" wherever it appears (the
sentence that currently reads "Run `openshell sandbox status` on the host for
full details." should instead read "Run `openshell sandbox list` on the host for
full details."); ensure the example/description around sandbox status detection
and host inspection remains unchanged except for this command correction.
In `@docs/reference/troubleshooting.md`:
- Line 92: Replace the invalid command invocation "openshell sandbox status"
with the correct command "openshell sandbox list" in the docs; update the text
line that currently reads Run `openshell sandbox status` to instead read Run
`openshell sandbox list` so the troubleshooting instructions point to the valid
command for checking sandbox state.
---
Nitpick comments:
In `@docs/reference/troubleshooting.md`:
- Line 64: Update the sentence "gateway's DNS has not finished propagating" in
troubleshooting.md to specify exactly which DNS or registration must propagate
(e.g., internal service mesh DNS records, gateway endpoint A/AAAA/CNAME entries,
or gateway endpoint registration in service discovery), and give a brief example
such as "the gateway's internal service mesh DNS record or external gateway
endpoint A/CNAME record has not finished propagating" so readers know whether to
check service-mesh DNS, external DNS entries, or gateway registration.
- Line 37: Replace the redundant platform phrase "Linux Ubuntu 22.04 LTS or
later" in the troubleshooting text with a simplified statement such as "Ubuntu
22.04 LTS or later" (or, if you want to keep OS family, "Linux (Ubuntu 22.04 LTS
or later)") so the platform requirement is clear and not repetitive; update the
sentence at the same location where the current line reads "NemoClaw requires
Linux Ubuntu 22.04 LTS or later." to the chosen simplified phrasing.
- Around line 50-51: Remove or fix MD014 warnings in the console code blocks by
either (a) removing the leading "$ " prompt from the shown commands (e.g., "sudo
nemoclaw setup-spark" and "nemoclaw onboard") so only the commands remain, (b)
adding representative command output lines immediately after each command to
justify keeping the "$ " prompt, or (c) disabling the rule for those blocks with
an inline markdownlint directive. Update the affected blocks in
docs/reference/troubleshooting.md accordingly so the markdown linter no longer
flags MD014.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5ae3d50e-d085-4e66-91d1-4edd281e98ee
📒 Files selected for processing (5)
README.mddocs/index.mddocs/monitoring/monitor-sandbox-activity.mddocs/reference/commands.mddocs/reference/troubleshooting.md
🚧 Files skipped from review as they are similar to previous changes (3)
- README.md
- docs/index.md
- docs/monitoring/monitor-sandbox-activity.md
This was referenced Mar 20, 2026
Ryuketsukami
pushed a commit
to Ryuketsukami/NemoClaw
that referenced
this pull request
Mar 24, 2026
…gular place (NVIDIA#331) * doc refresh and start troubleshooting page * refresh doc and start collecting troubleshooting * openshell command fix
jessesanford
pushed a commit
to jessesanford/NemoClaw
that referenced
this pull request
Mar 24, 2026
…gular place (NVIDIA#331) * doc refresh and start troubleshooting page * refresh doc and start collecting troubleshooting * openshell command fix
mafueee
pushed a commit
to mafueee/NemoClaw
that referenced
this pull request
Mar 28, 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
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 by CodeRabbit