docs: add OpenClaw plugin install guide (Fixes #2538) - #2587
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (4)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds user-facing documentation for installing OpenClaw plugins via NemoClaw: a new how-to guide, an expanded remote-deploy skill SKILL.md section with plugin onboarding steps, and clarifications in command reference and site navigation distinguishing plugins from agent skills. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/deployment/install-openclaw-plugins.md (1)
89-97:⚠️ Potential issue | 🟡 MinorAdd a
Next Stepssection at the end of the page.New docs pages in
docs/require a bottomNext Stepssection linking related pages.As per coding guidelines: "A 'Next Steps' section at the bottom links to related pages."Suggested edit
## Common Mistakes - Do not use `nemoclaw <sandbox> skill install` for OpenClaw plugins. That command only installs `SKILL.md` agent skills. - Do not put a Dockerfile in a broad directory such as `/tmp` unless you intend to send that whole directory as the Docker build context. - Keep plugin dependencies in the build stage or plugin directory; avoid copying unrelated host files into the sandbox image. + +## Next Steps + +- Review [Network Policies](../reference/network-policies.md) to plan plugin egress safely. +- Follow [Customize Network Policy](../network-policy/customize-network-policy.md) to tailor presets. +- Return to [Deploy to a Remote GPU Instance](deploy-to-remote-gpu.md) for remote-host workflows.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/deployment/install-openclaw-plugins.md` around lines 89 - 97, Add a "Next Steps" section at the end of the "Install OpenClaw plugins" doc (right after the existing "Common Mistakes" section) titled "Next Steps" and include bulleted links to related documentation pages such as "Deployment overview", "Plugin development", and "Sandbox guidelines" so readers can continue to relevant topics; ensure the links use the same relative link format as other docs pages and include one-sentence context for each link.
🤖 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/deployment/install-openclaw-plugins.md`:
- Around line 49-50: Add a one-sentence intro under each H2/H3 header before its
code block or list: specifically insert a brief explanatory sentence immediately
under the "Example Dockerfile", "Create the Sandbox", and "Common Mistakes"
headings so the reader gets context before the Dockerfile, sandbox onboarding
commands, and the list of pitfalls; apply the same pattern to the other H2/H3
sections called out in the review so every section begins with a short
introductory sentence before any code or list content.
---
Outside diff comments:
In `@docs/deployment/install-openclaw-plugins.md`:
- Around line 89-97: Add a "Next Steps" section at the end of the "Install
OpenClaw plugins" doc (right after the existing "Common Mistakes" section)
titled "Next Steps" and include bulleted links to related documentation pages
such as "Deployment overview", "Plugin development", and "Sandbox guidelines" so
readers can continue to relevant topics; ensure the links use the same relative
link format as other docs pages and include one-sentence context for each link.
🪄 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: Enterprise
Run ID: f6eac7a9-fe4f-44d1-b310-13852b2dc0b5
📒 Files selected for processing (5)
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md.agents/skills/nemoclaw-user-reference/references/commands.mddocs/deployment/install-openclaw-plugins.mddocs/index.mddocs/reference/commands.md
Fixes NVIDIA#2538 Signed-off-by: Deepak Jain <deepujain@gmail.com>
1221d01 to
7f7d4e2
Compare
|
Rebased on latest main. Added the requested section intros and Next Steps footer, then regenerated the user skill docs. npm run build:cli and npm test -- test/skills-frontmatter.test.ts pass. |
## Summary NemoClaw docs did not explain how OpenClaw plugins should be installed under NemoClaw. This adds a deployment guide that points plugin users to the supported custom-sandbox-image path. ## Changes - Add an OpenClaw plugin install guide with a build-directory layout and Dockerfile example. - Link the guide from the docs deployment index. - Add a note under `skill install` that OpenClaw plugins are different from SKILL.md agent skills. - Regenerate the generated `nemoclaw-user` skills content. ## Testing - `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user` passed. - `npm test -- test/skills-frontmatter.test.ts` passed: 38 tests. - `npm run build:cli` passed. - `npx prettier --check docs/deployment/install-openclaw-plugins.md docs/index.md docs/reference/commands.md .agents/skills/nemoclaw-user-deploy-remote/SKILL.md .agents/skills/nemoclaw-user-reference/references/commands.md` passed. - Full `npm test -- --reporter=dot` was attempted. In this local checkout it still fails in unrelated installer/uninstall/onboard tests and generated-dist lookup paths. ## Evidence it works The docs generator picked up the new plugin install page and updated the generated deployment skill content. Fixes #2538 Signed-off-by: Deepak Jain <deepujain@gmail.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive OpenClaw plugins deployment guide with Dockerfile-based preparation, build and onboarding workflow, configuration notes, and troubleshooting. * Clarified that OpenClaw plugins are distinct from agent skills and require a separate installation process; updated command reference links accordingly. * Updated documentation navigation and renumbered onboarding steps to account for the new plugin content. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Deepak Jain <deepujain@gmail.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>
) ## Summary NemoClaw docs did not explain how OpenClaw plugins should be installed under NemoClaw. This adds a deployment guide that points plugin users to the supported custom-sandbox-image path. ## Changes - Add an OpenClaw plugin install guide with a build-directory layout and Dockerfile example. - Link the guide from the docs deployment index. - Add a note under `skill install` that OpenClaw plugins are different from SKILL.md agent skills. - Regenerate the generated `nemoclaw-user` skills content. ## Testing - `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user` passed. - `npm test -- test/skills-frontmatter.test.ts` passed: 38 tests. - `npm run build:cli` passed. - `npx prettier --check docs/deployment/install-openclaw-plugins.md docs/index.md docs/reference/commands.md .agents/skills/nemoclaw-user-deploy-remote/SKILL.md .agents/skills/nemoclaw-user-reference/references/commands.md` passed. - Full `npm test -- --reporter=dot` was attempted. In this local checkout it still fails in unrelated installer/uninstall/onboard tests and generated-dist lookup paths. ## Evidence it works The docs generator picked up the new plugin install page and updated the generated deployment skill content. Fixes NVIDIA#2538 Signed-off-by: Deepak Jain <deepujain@gmail.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive OpenClaw plugins deployment guide with Dockerfile-based preparation, build and onboarding workflow, configuration notes, and troubleshooting. * Clarified that OpenClaw plugins are distinct from agent skills and require a separate installation process; updated command reference links accordingly. * Updated documentation navigation and renumbered onboarding steps to account for the new plugin content. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Deepak Jain <deepujain@gmail.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Summary
NemoClaw docs did not explain how OpenClaw plugins should be installed under NemoClaw. This adds a deployment guide that points plugin users to the supported custom-sandbox-image path.
Changes
skill installthat OpenClaw plugins are different from SKILL.md agent skills.nemoclaw-userskills content.Testing
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-userpassed.npm test -- test/skills-frontmatter.test.tspassed: 38 tests.npm run build:clipassed.npx prettier --check docs/deployment/install-openclaw-plugins.md docs/index.md docs/reference/commands.md .agents/skills/nemoclaw-user-deploy-remote/SKILL.md .agents/skills/nemoclaw-user-reference/references/commands.mdpassed.npm test -- --reporter=dotwas attempted. In this local checkout it still fails in unrelated installer/uninstall/onboard tests and generated-dist lookup paths.Evidence it works
The docs generator picked up the new plugin install page and updated the generated deployment skill content.
Fixes #2538
Signed-off-by: Deepak Jain deepujain@gmail.com
Summary by CodeRabbit