Skip to content

docs: update plugin publish - #9415

Open
XTsat wants to merge 3 commits into
AstrBotDevs:masterfrom
XTsat:master
Open

docs: update plugin publish#9415
XTsat wants to merge 3 commits into
AstrBotDevs:masterfrom
XTsat:master

Conversation

@XTsat

@XTsat XTsat commented Jul 27, 2026

Copy link
Copy Markdown

Modifications / 改动点

将 AstrBot 开发指南 的 发布插件页面 进行更新,改为新的插件市场链接,并加入一个完整解析格式的案例

  • This is NOT a breaking change. / 这不是一个破坏性变更。

Screenshots or Test Results / 运行截图或测试结果

image image

Checklist / 检查清单

  • 😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
    / 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。

  • 👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
    / 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”

  • 🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in requirements.txt and pyproject.toml.
    / 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到 requirements.txtpyproject.toml 文件相应位置。

  • 😮 My changes do not introduce malicious code.
    / 我的更改没有引入恶意代码。

Summary by Sourcery

Update AstrBot plugin publishing documentation to reflect the new cloud-based publish flow and clarify packaging requirements.

Documentation:

  • Refresh English and Chinese plugin publishing guides to point to the new AstrBot Cloud publish page and account requirement.
  • Add a complete metadata.yaml example for plugins, including optional fields and supported platform references.
  • Reformat and expand the plugin package size limit section with clearer guidance on reducing archive size.

@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jul 27, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've found 1 issue, and left some high level feedback:

  • In the new intro sentence for the publish flow (“...Publish Page..., You need to register...”), consider fixing the comma splice by splitting it into two sentences or using “and” for better readability in both EN and ZH versions.
  • The new links to supported platform adapters (plugin-new.md#declare-supported-platforms-optional / #声明支持平台-optional) rely on specific anchors; double-check that the target headings and generated IDs actually match these fragments to avoid broken intra-doc links.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the new intro sentence for the publish flow (“...Publish Page..., You need to register...”), consider fixing the comma splice by splitting it into two sentences or using “and” for better readability in both EN and ZH versions.
- The new links to supported platform adapters (`plugin-new.md#declare-supported-platforms-optional` / `#声明支持平台-optional`) rely on specific anchors; double-check that the target headings and generated IDs actually match these fragments to avoid broken intra-doc links.

## Individual Comments

### Comment 1
<location path="docs/zh/dev/star/plugin-publish.md" line_range="33-37" />
<code_context>
-> 如果插件确实因业务需要无法压缩到 16MB 以内,可以联系维护者手动 bypass 此限制。
+[目前支持的平台适配器](plugin-new.md#声明支持平台-optional)
+
+::: warning 大小限制
+发布到插件市场的插件压缩包(zip)大小**不得超过 16MB**+
+如果超过此限制,CI/CD 流水线将自动拒绝该发布请求。
+::: details 为确保你的插件能顺利通过审核和发布,建议采取以下措施:
+
+- **压缩图片等静态资源**:对插件中的图片、音频等资源文件进行压缩,减小体积。
</code_context>
<issue_to_address>
**issue (bug_risk):** Similarly, close the `warning` container before opening the `details` container in the Chinese docs.

这里的 `warning` 容器开启后未单独使用一行 `:::` 关闭,就直接开启了 `details` 容器,可能导致渲染异常。请在告警内容结束后补上一行单独的 `:::` 关闭 `warning`,再开启 `details`。
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread docs/zh/dev/star/plugin-publish.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant