docs: clarify OpenShell compatibility guidance#1263
Open
13ernkastel wants to merge 6 commits intoNVIDIA:mainfrom
Open
docs: clarify OpenShell compatibility guidance#126313ernkastel wants to merge 6 commits intoNVIDIA:mainfrom
13ernkastel wants to merge 6 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 (6)
✅ Files skipped from review due to trivial changes (4)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds OpenShell compatibility documentation and warnings (pinning NemoClaw 0.1.0 to OpenShell 0.0.7), a new exported Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 3❌ Failed checks (2 warnings, 1 inconclusive)
✅ Passed checks (2 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 (2)
docs/reference/commands.md (1)
69-69: Switch the validation clause to active voice.Line 69 uses passive voice (“was validated against”); docs style requires active wording.
As per coding guidelines:
docs/**: Active voice required. Flag passive constructions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` at line 69, The sentence uses passive voice ("NemoClaw 0.1.0 was validated against"); change it to active voice by rewriting the clause to something like "than the OpenShell release that NemoClaw 0.1.0 validates against" (locate the sentence containing "NemoClaw 0.1.0 was validated against" in docs/reference/commands.md and replace that passive clause with an active construction referencing NemoClaw 0.1.0 validating the release).docs/get-started/quickstart.md (1)
57-57: Use active, present-tense phrasing for the compatibility baseline.Line 57 uses passive past tense (“was validated”), which conflicts with the docs style requirements.
As per coding guidelines:
docs/**: Active voice required. Flag passive constructions.anddocs/**: Present tense. Flag future tense ("will") in descriptions of current behavior.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/get-started/quickstart.md` at line 57, Summary: The compatibility sentence uses passive past tense; change it to active present-tense. Replace the current text "NemoClaw 0.1.0 was validated with OpenShell 0.0.7." with an active present-tense phrasing such as "NemoClaw 0.1.0 works with OpenShell 0.0.7." or "NemoClaw 0.1.0 validates against OpenShell 0.0.7." Update that single sentence in the quickstart paragraph to use active voice and present tense to comply with the docs style rules.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@bin/lib/onboard.js`:
- Around line 2159-2161: The compatibility notice loop using
getOpenshellCompatibilityNotice(gatewayEnv.IMAGE_TAG || null) is never reached
when startGatewayWithOptions returns early on healthy reuse; move or duplicate
the notice emission so it always runs regardless of gateway reuse. Specifically,
call getOpenshellCompatibilityNotice and log each line before invoking
startGatewayWithOptions (or ensure startGatewayWithOptions invokes a
callback/hook that prints the same lines on both new-start and healthy-reuse
paths) so the lifecycle boundary message is always printed.
- Around line 522-528: The getOpenshellCompatibilityNotice function currently
always returns informational text; update it to detect incompatible OpenShell
versions by comparing the passed version (version param) against the supported
NemoClaw↔OpenShell mapping (e.g., a supportedVersions array or mapping constant
you add) using semantic version checks (semver.satisfies or equivalent) and
return a warning message (or an array with a prominent warning line) when the
version does not satisfy the supported range; keep the existing informational
lines when compatible and ensure the function still handles null/unknown version
by returning a neutral notice.
---
Nitpick comments:
In `@docs/get-started/quickstart.md`:
- Line 57: Summary: The compatibility sentence uses passive past tense; change
it to active present-tense. Replace the current text "NemoClaw 0.1.0 was
validated with OpenShell 0.0.7." with an active present-tense phrasing such as
"NemoClaw 0.1.0 works with OpenShell 0.0.7." or "NemoClaw 0.1.0 validates
against OpenShell 0.0.7." Update that single sentence in the quickstart
paragraph to use active voice and present tense to comply with the docs style
rules.
In `@docs/reference/commands.md`:
- Line 69: The sentence uses passive voice ("NemoClaw 0.1.0 was validated
against"); change it to active voice by rewriting the clause to something like
"than the OpenShell release that NemoClaw 0.1.0 validates against" (locate the
sentence containing "NemoClaw 0.1.0 was validated against" in
docs/reference/commands.md and replace that passive clause with an active
construction referencing NemoClaw 0.1.0 validating the release).
🪄 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: Pro
Run ID: be09412d-9cfa-43b7-bc2c-f24b389173bc
📒 Files selected for processing (6)
README.mdbin/lib/onboard.jsdocs/about/how-it-works.mddocs/get-started/quickstart.mddocs/reference/commands.mdtest/onboard.test.js
wscurran
added
documentation
Contributor
|
✨ Thanks for submitting this pull request, which proposes a way to improve the documentation and onboarding process for NemoClaw with OpenShell. Possibly related open issues:
|
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.
Fixes #1261
Summary
nemoclaw onboardis the supported path for creating or recreating NemoClaw-managed sandboxesTesting
npx vitest run test/onboard.test.jsnpx eslint bin/lib/onboard.js test/onboard.test.jsSummary by CodeRabbit
Documentation
nemoclaw onboardis the supported entry point and warned against running specific OpenShell update/recreate/create commands directly.New Features
Tests