Skip to content

docs(openclaw): document plugin-source / plugin-package and plugin-version auto-detect from #2072#2077

Merged
MaojiaSheng merged 2 commits into
volcengine:mainfrom
r266-tech:r266-tech/docs-openclaw-install-plugin-source-from-2072
May 15, 2026
Merged

docs(openclaw): document plugin-source / plugin-package and plugin-version auto-detect from #2072#2077
MaojiaSheng merged 2 commits into
volcengine:mainfrom
r266-tech:r266-tech/docs-openclaw-install-plugin-source-from-2072

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Description

Docs catch of #2072 (LinQiang391, merged 2026-05-15 by qin-ctx). setup-helper/install.js gained npm-default install path and three new behaviors that were not reflected in docs/{en,zh}/agent-integrations/03-openclaw.md:

  1. Default source switched to npm. pluginSource defaults to "npm" (install.js L34), installing @openviking/openclaw-plugin@latest. Previously docs implied GitHub source.
  2. --plugin-version auto-detects between npm and GitHub: npm version (e.g. 2026.5.8) or npm dist-tag (e.g. dev) → npm; other refs (e.g. v0.3.16, main) → GitHub. Previous doc text said "supports tag, branch, or commit", which is ambiguous for the new dual-source behavior.
  3. Two new flags surfaced in --help (install.js L336-338) had no doc row:
    • --plugin-source=npm|github
    • --plugin-package=NAME

Changes

  • docs/en/agent-integrations/03-openclaw.md: tightened --plugin-version description; added --plugin-source + --plugin-package rows (+3 / -1).
  • docs/zh/agent-integrations/03-openclaw.md: mirror in Chinese (+3 / -1).

Pipe character inside `--plugin-source=npm|github` is escaped (npm\|github) so the Markdown table row doesn't split.

Verification

Related

Type of Change

  • Documentation update

Please feel free to close if a follow-up by the original author is preferred — happy to defer.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2072 - Fully compliant

Compliant requirements:

  • Document the new --plugin-source and --plugin-package flags
  • Document --plugin-version auto-detect behavior
  • Update both English and Chinese documentation
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@MaojiaSheng MaojiaSheng merged commit bc8fe8b into volcengine:main May 15, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants