插件设置页、版本与关于入口规范 v1
确认日期:2026-10-02。适用于所有官方插件及后续第三方插件。
本规范确认产品要求;现有插件界面、审核服务与开放平台网站需分别实施和验收,不能把新增文档当成已安装插件已经更新。
1. 设置页面底部统一入口
每个插件必须提供可到达的设置页面,包括没有业务配置项的插件。设置页面的业务设置之后,统一展示以下两项:
| 内容 | 展示 | 点击行为 |
|---|---|---|
| 版本 | 版本 2.14.4-rc.3(示例) | 进入该插件的更新日志,定位当前安装版本 |
| 关于 | 关于插件 | 打开 open.reai.com 中该插件的具体应用详情页 |
- 顺序为「版本」在前、「关于插件」在后;处于设置内容最底部的普通文档流内,不浮动覆盖配置项。短页面可通过布局留白落在底部,长页面随正文滚动可到达。
- 采用 插件设计规范 §6.1 的设置行、间距、主题 Token 与分隔语义;窄窗和长版本号自然换行,支持键盘访问、焦点态和中英文。
- 版本号必须由构建时读取
app.manifest.json.version获得,并与当前安装包一致;不得写死另一份常量,不用 Host 版本或网站最新版本替代本机版本。 - 两项使用有明确语义的链接或按钮,读屏名称为「查看版本 {version} 的更新日志」「关于 {pluginName}」。不能只显示不可点击的版本文字。
- 对外导航遵循现有 Host/SDK 允许的入口和链接校验,不注入 Host DOM、不擅自扩充 Manifest Schema 或网络权限。没有当前能力时记录实施阻塞,不绕过平台。
- 离线或目标暂不可用时保留本机版本和入口,给出真实提示及重试;不能显示空白成功页、跳到其他插件或静默跳平台首页。
2. 开放平台的稳定地址
以下是新站实施采用的 URL 合同,当前不代表这些线上路由已部署:
| 页面 | 地址约定 |
|---|---|
| 插件关于 / 应用详情 | https://open.reai.com/apps/<appId> |
| 插件更新日志 | https://open.reai.com/apps/<appId>/changelog?version=<encodedVersion> |
| 开发规范与开发文档 | https://open.reai.com/docs/ |
| 应用案例 | https://open.reai.com/showcase/<caseSlug> |
appId 使用正式 Manifest 的稳定标识;路径段和版本查询参数分别编码,显示名称修改不改变地址。产品后台的 Product ID、OAuth Client ID 不取代 appId,也不新增未受 Schema 支持的 Manifest 字段。
更新日志必须保留历史版本,并能精确定位旧安装版本。找不到目标版本时明确显示「此版本的更新日志尚未发布」,仍可查看其他公开历史记录;不能用最新版记录冒充当前版本。未获准公开的候选条目不自动出现在公共页面。
应用详情承载插件介绍、发布者、功能、截图、兼容要求、必要权限、已发布版本和更新日志入口;发布与可安装状态以正式 Catalog/release 为准。
3. 每次审核提交自动完成版本介绍撰写
文档事实源为每个插件自己的 plugins/<slug>/CHANGELOG.md,按版本记录,不能拿 docs/CHANGELOG.md 的平台规范变更充当插件更新日志。
准备每次审核提交时,执行开发/送审任务的 AI 或开发工作流自动完成以下步骤,不要求用户另行撰写介绍:
- 确定上一已发布版本与本次候选的真实差异,核对 appId、Manifest / package / 提交配置版本及验证证据;初次提交说明初版功能。基线不明时明确记录,不猜测。
- 在插件更新日志中为送审版本生成面向用户的标题、一段简短介绍,以及新增 / 改进 / 修复条目;说明实际影响、兼容或权限变化及必要操作。没有实际变化的分类省略。
- 把功能证据、验收范围和候选状态记在送审材料中;用户日志不用堆内部实现术语,不含 token、私钥、用户数据或未经许可的素材。
- 复核文案与实际改动一致,确保当前版本有非空条目,设置页能打开对应日志和具体应用详情;不满足时不得声称提交材料完整。
- 将条目和该次候选输入绑定并保留送审证据。审核受理、批准、签名和公开发布各自独立;只有显式获准发布的版本才同步到开放平台公共日志,撤回和拒绝的候选不冒称已发布。
同版本同载荷重试复用原条目,不重复追加。修改版本或输入后更新相应候选并重新审核;历史已发布条目不覆盖删除,勘误注明日期与原因。
推荐模板(占位符必须用实际证据填写,不得原样送审):
## <version>
### <面向用户的标题>
<简短说明本次能做什么,以及对用户的影响。>
- 新增:<实际新增功能,可省略>
- 改进:<实际体验变化,可省略>
- 修复:<用户可感知的问题及修复结果,可省略>
- 使用提示:<兼容要求、权限变化或必要操作,可省略>自动生成服务器服务、公共日志同步和机器阻断检查仍需后续实施。本次通过仓库 AGENTS.md 约束开发/送审工作流;不宣称已有自动发布流水线。
4. 审查与验收
- 全部插件:设置页底部两个入口在长短内容、明暗主题、窄窗、中英文中可见可达。
- 版本:显示最终安装包版本;点击定位同 appId 的精确版本文档,验证旧版本及缺失版本行为。
- 关于:点击到具体应用详情,页面身份与安装插件一致;不能到平台首页。
- 送审:对应插件更新日志包含目标版本的真实介绍,同版本重试不重复,未发布记录不公开。
- 证据:保留实际插件版本 / 包摘要、截图与点击记录;源码检查和文档构建通过不能替代真实 Host 点击验收。
5. 文档迁移边界
open.reai.com 作为插件、应用案例和开发文档的统一开放平台。首页与站点设计先在 open-website/ 进行,现有 website/ 保留文档站源码。
现有 https://ai-board.reai.com/docs/ 的文档部分未来迁至 https://open.reai.com/docs/;以 docs/ 为内容事实源,避免两套规范分叉。迁移时保持原路径/锚点可追溯,完成逐页重定向、链接检查与部署验收后才切换文档入口。