Skip to content

docs: fix misleading OpenClaw install note and remove unsupported deploy command#342

Closed
flobo3 wants to merge 1 commit intoNVIDIA:mainfrom
flobo3:fix/readme-issues
Closed

docs: fix misleading OpenClaw install note and remove unsupported deploy command#342
flobo3 wants to merge 1 commit intoNVIDIA:mainfrom
flobo3:fix/readme-issues

Conversation

@flobo3
Copy link
Copy Markdown

@flobo3 flobo3 commented Mar 18, 2026

Fixes #322
Fixes #323

Summary

This PR addresses two documentation issues in the README.md:

  1. Misleading OpenClaw installation note (README "fresh installation of OpenClaw" note implies a manual step that does not exist #322): The previous note stated that "NemoClaw currently requires a fresh installation of OpenClaw," which implied a manual prerequisite step. It has been reworded to clarify that NemoClaw handles the creation of a fresh OpenClaw instance inside the sandbox during the onboarding process.
  2. Unsupported deploy command (Remove deploy command from Key Commands table in README #323): The nemoclaw deploy <instance> command was listed in the Key Commands table but is not part of the currently supported scope. It has been removed to avoid setting incorrect expectations.

Changes

  • Reworded the Quick Start note regarding OpenClaw installation.
  • Removed the nemoclaw deploy row from the Key Commands table.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 18, 2026

📝 Walkthrough

Walkthrough

Clarified README Quick Start to state NemoClaw creates a fresh OpenClaw instance inside the sandbox during onboarding and removed the unsupported nemoclaw deploy <instance> entry from the Key Commands table.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Reworded Quick Start note to indicate NemoClaw creates a fresh OpenClaw instance inside the sandbox during nemoclaw onboard. Removed the nemoclaw deploy <instance> row from the Key Commands table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines and made it clear,
No extra installs need appear,
Inside the sandbox a fresh claw grows,
One less command off the table goes,
Docs now whisper—welcome here! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main changes: fixing misleading OpenClaw installation documentation and removing an unsupported deploy command.
Linked Issues check ✅ Passed The changes directly address both linked issues: the onboarding note reworded to clarify internal OpenClaw setup [#322], and the unsupported deploy command removed from Key Commands [#323].
Out of Scope Changes check ✅ Passed All changes are scoped to the two documentation issues: README.md updates for the onboarding note and deploy command removal, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

You can customize the high-level summary generated by CodeRabbit.

Configure the reviews.high_level_summary_instructions setting to provide custom instructions for generating the high-level summary.

@flobo3 flobo3 force-pushed the fix/readme-issues branch from b6db4f5 to b19b226 Compare March 18, 2026 20:09
@ericksoa
Copy link
Copy Markdown
Contributor

Thanks for spotting both of these @flobo3! We went ahead with our own PR (#370) covering the same fixes. Appreciate the contribution!

@ericksoa ericksoa closed this Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove deploy command from Key Commands table in README README "fresh installation of OpenClaw" note implies a manual step that does not exist

2 participants