docs: catch up documentation for v0.0.14 changes#1855
Conversation
Document the max_openshell_version constraint added in v0.0.14: - Add troubleshooting entry for "OpenShell version above maximum" error - Document version range enforcement in the onboard preflight section Made-with: Cursor
|
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 (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates add OpenShell version compatibility checks to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 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 |
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/troubleshooting.md`:
- Line 168: The docs line "Upgrade NemoClaw to a version that supports your
OpenShell release, or install a supported OpenShell version from the OpenShell
releases page" links to a GitHub releases page which violates the docs rule;
update that sentence to point to the official OpenShell (or NemoClaw) product
documentation or user guide instead of the GitHub releases URL, replacing the
existing link target and link text so it references the official documentation
site or version compatibility page (keep the sentence meaning and link semantics
intact).
🪄 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 Plus
Run ID: 49e129d4-18df-4ef2-9f10-bd5497a4489b
📒 Files selected for processing (4)
.agents/skills/nemoclaw-user-reference/references/commands.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.mddocs/reference/commands.mddocs/reference/troubleshooting.md
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 @.agents/skills/nemoclaw-contributor-update-docs/SKILL.md:
- Line 173: Replace the sentence that claims CI can identify doc-only changes
with wording that clarifies the `documentation` label is for human reviewers and
maintainers rather than CI; specifically update the line referencing the
`documentation` label so it says something like "When the workflow produces a
pull request, apply the `documentation` label so reviewers and maintainers can
identify doc-only changes" and avoid implying label-driven CI behavior (edit the
sentence containing `documentation` label in SKILL.md).
🪄 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 Plus
Run ID: d10b66de-613c-4af1-9633-21432cec5459
📒 Files selected for processing (1)
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md
## Summary Catches up documentation for user-facing changes merged between v0.0.13 and v0.0.14 that shipped without doc updates. - **Troubleshooting**: Add entry for "OpenShell version above maximum" error when installed OpenShell exceeds the blueprint's `max_openshell_version` - **Commands**: Document version range enforcement (`min_openshell_version` / `max_openshell_version`) in the onboard preflight section ### Commits covered | Commit | Change | |--------|--------| | `d4aac4c6` | `feat(blueprint): enforce maximum OpenShell version constraint` | ### Commits with no doc impact (v0.0.14) - `fcb5fd66` — block secret writes into persistent workspace memory (already shipped with doc updates in the same commit) - `1ba57abf` — CI-only (skip dco-check for Dependabot) ## Test plan - [x] `make docs` builds without warnings - [x] Pre-commit hooks pass - [ ] Review rendered pages for accuracy Made with [Cursor](https://cursor.com) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Onboarding docs updated to validate installed OpenShell against blueprint min/max versions and immediately surface actionable errors with links to compatible releases. * New troubleshooting entry for OpenShell version mismatches (above maximum) with remediation steps and note that fresh installs are pinned to the validated maximum. * Docs-update workflow now includes a step to label documentation-only pull requests. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary Catches up documentation for user-facing changes merged between v0.0.13 and v0.0.14 that shipped without doc updates. - **Troubleshooting**: Add entry for "OpenShell version above maximum" error when installed OpenShell exceeds the blueprint's `max_openshell_version` - **Commands**: Document version range enforcement (`min_openshell_version` / `max_openshell_version`) in the onboard preflight section ### Commits covered | Commit | Change | |--------|--------| | `d4aac4c6` | `feat(blueprint): enforce maximum OpenShell version constraint` | ### Commits with no doc impact (v0.0.14) - `fcb5fd66` — block secret writes into persistent workspace memory (already shipped with doc updates in the same commit) - `1ba57abf` — CI-only (skip dco-check for Dependabot) ## Test plan - [x] `make docs` builds without warnings - [x] Pre-commit hooks pass - [ ] Review rendered pages for accuracy Made with [Cursor](https://cursor.com) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Onboarding docs updated to validate installed OpenShell against blueprint min/max versions and immediately surface actionable errors with links to compatible releases. * New troubleshooting entry for OpenShell version mismatches (above maximum) with remediation steps and note that fresh installs are pinned to the validated maximum. * Docs-update workflow now includes a step to label documentation-only pull requests. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: ColinM-sys <cmcdonough@50words.com>
Summary
Catches up documentation for user-facing changes merged between v0.0.13 and v0.0.14 that shipped without doc updates.
max_openshell_versionmin_openshell_version/max_openshell_version) in the onboard preflight sectionCommits covered
d4aac4c6feat(blueprint): enforce maximum OpenShell version constraintCommits with no doc impact (v0.0.14)
fcb5fd66— block secret writes into persistent workspace memory (already shipped with doc updates in the same commit)1ba57abf— CI-only (skip dco-check for Dependabot)Test plan
make docsbuilds without warningsMade with Cursor
Summary by CodeRabbit