Skip to content

docs: catch up documentation for v0.0.14 changes#1855

Merged
miyoungc merged 3 commits intomainfrom
docs/catchup-v0.0.14
Apr 14, 2026
Merged

docs: catch up documentation for v0.0.14 changes#1855
miyoungc merged 3 commits intomainfrom
docs/catchup-v0.0.14

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 14, 2026

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

  • make docs builds without warnings
  • Pre-commit hooks pass
  • Review rendered pages for accuracy

Made with Cursor

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.

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
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9b44b986-d7d2-4a2a-8829-9fbf75dd1d5e

📥 Commits

Reviewing files that changed from the base of the PR and between c5472be and 48abac7.

📒 Files selected for processing (1)
  • .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/nemoclaw-contributor-update-docs/SKILL.md

📝 Walkthrough

Walkthrough

Documentation updates add OpenShell version compatibility checks to nemoclaw onboard preflight, enforcing min_openshell_version and max_openshell_version from the blueprint and describing the actionable error and link shown when the installed OpenShell is outside the range.

Changes

Cohort / File(s) Summary
Commands Documentation
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Preflight checks docs updated to describe validation of the installed OpenShell against min_openshell_version / max_openshell_version from the blueprint; onboarding terminates with an actionable error and link to compatible releases on mismatch.
Troubleshooting Documentation
.agents/skills/nemoclaw-user-reference/references/troubleshooting.md, docs/reference/troubleshooting.md
Added “OpenShell version above maximum” troubleshooting guidance: expected error format, guidance to upgrade NemoClaw or install a supported OpenShell version, and note that install-openshell.sh pins fresh installs to the validated maximum.
Docs workflow
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Added “Step 8: Label PRs” instructing gh pr edit <number> --add-label documentation for PRs created by the docs-update workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 I checked the versions, tidy and keen,
I hopped through docs both calm and mean,
Min and max now clearly shown,
No more mismatches left alone,
Carrot-approved, the guide is clean! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: documentation updates to catch up with v0.0.14 feature changes, matching the changeset which adds documentation for OpenShell version enforcement and troubleshooting sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/catchup-v0.0.14

Comment @coderabbitai help to get the list of available commands and usage tips.

@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 14, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39a3543 and bc74e5d.

📒 Files selected for processing (4)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/reference/commands.md
  • docs/reference/troubleshooting.md

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc74e5d and c5472be.

📒 Files selected for processing (1)
  • .agents/skills/nemoclaw-contributor-update-docs/SKILL.md

@miyoungc miyoungc merged commit 3f7e083 into main Apr 14, 2026
12 checks passed
@cv cv added the v0.0.15 Release target label Apr 14, 2026
ericksoa pushed a commit to cheese-head/NemoClaw that referenced this pull request Apr 14, 2026
## 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 -->
ColinM-sys pushed a commit to ColinM-sys/NemoClaw that referenced this pull request Apr 14, 2026
## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v0.0.15 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants