ZUI 扩展库正式文档

SkillDev tools

Lets your agent write, fix, and review official documentation for ZUI extension component libraries.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the ZUI 扩展库正式文档 skill

About this capability

维护独立 ZUI 扩展库的官网文档源、API 说明和示例,按需通过宿主验证。需求明确时直接实施;只要求审阅时保持只读。

What this skill tells your AI

The instructions your AI receives, as published by easysoft/zui in skills-exts/zuix-doc/SKILL.md and read by ahel’s review.

准备

  1. 在采取其他任务动作前,完整读取 ../zuix-standards/SKILL.md
  2. 从当前技能目录运行只读 resolver:
node ../zuix-standards/scripts/resolve-zui-ext-context.mjs --cwd <目标路径> --lib <目录名或包名> [--host <宿主根>] --json
  1. 记录 resolver 输出的 targetLibRootextensionRootgitRootzuiRootextsNamefolderNamepackageNamezuiNamepublicPathdependencyPolicy。模块导入使用 packageName,宿主库选择与文档组件标识核对使用 zuiName,资源路径使用实际 publicPath;不要从目录名推导它们。
  2. zuix-standards 的路由完整读取工作流与正式文档规范。完整读取各层适用的 AGENTS.md,检查 gitRoot 状态;始终通过 targetLibRoot 的真实路径维护文档源,不通过宿主 exts/ 符号链接写入。
  3. zuiRootextsName 未解析时不猜测宿主、组名或文档命令。可以进行源码事实核对和源 Markdown 编辑;若请求要求同步、构建或浏览器验收,明确报告宿主上下文缺口。
  4. 阅读目标 package.json、入口、公开类型、component/vanilla/helper、样式、i18n、README.mddev.mddev.ts、已有正式文档及两个相似库文档。优先扩展项目内参考,不足时再读当前 zuiRoot 的成熟内置文档。

写作与实施

  1. 缺少会改变目标库、文档类别或受众的信息时先询问;否则直接在正式文档边界内实施,不增加确认门禁。
  2. 以目标源码和实际导出为事实来源,不根据 folderNamepackageNamezuiName 猜测 API。发现源码与预期冲突时单独报告,不为让文档成立越界修改运行时代码。
  3. 优先沿用已有分类;否则根据当前宿主文档规范和目标角色选择 targetLibRoot/docs/lib/<category>/index.mdindex.md 是默认主页面,仅在已有结构或用户明确要求时维护额外页面。
  4. 第一屏提供用途说明和可运行基础示例,随后按真实 API 补充常用场景、options/props、事件、方法、类型、CSS 类/变量、引入方式、无障碍与限制;不保留空章节。
  5. 官网示例严格使用当前 zuiRoot 提供的 <Example>、tabs、<Props><ZUI> 等语法,不混用调试页 html:example fence。
  6. 模块化示例使用真实 packageName。全局成员、声明式创建和 <ZUI use> 必须通过宿主联合构建确认,不能仅凭源码导出或目录名推断;相关标识通常关联 zuiName,仍以当前宿主发现结果为准。
  7. 文档资源保存在目标扩展库约定位置,引用路径根据当前宿主同步规则和实际 publicPath 验证。不要硬编码某个扩展品牌、组名或本机绝对路径。
  8. 只修改 targetLibRoot 内正式文档及明确需要的文档资源。源码 lint、依赖与静态检查从 extensionRoot 执行;不得编辑 zuiRoot/docs/_ 或其他宿主生成目录、源码、package、lockfile和注册配置。

验证

  1. extensionRoot 运行扩展项目实际提供的 Markdown、链接、lint 或源文件检查;先读取 package scripts,不套用宿主命令。
  2. 需要同步或构建时,只有 resolver 已确认 zuiRootextsName 及对应注册后,才从 zuiRoot 使用扩展文档入口。优先使用宿主实际提供的命令,例如:
pnpm docs:build:exts

若当前宿主支持按扩展组筛选,使用准确 extsName;不发明不存在的参数。确认目标 zuiName 实际进入文档构建。 3. 需要浏览器验证时从 zuiRoot 启动 pnpm docs:dev:exts 或当前等价脚本,检查示例渲染、交互、资源、链接和控制台;完成后结束持续进程。 4. 区分源文件检查、宿主同步/构建、浏览器验证和宿主基线失败。不得把生成后的 docs/_ 变化作为扩展库交付文件。

组合边界与交付

  • 独立调用且需求明确时直接实施。
  • ../zuix-component/SKILL.md../zuix-helper/SKILL.md../zuix-lib/SKILL.md../zuix-optimize/SKILL.md 组合时,只实施共享已批准文档范围,不重复确认。
  • 用户只要求审阅或建议时保持只读。
  • 交付时汇报目标源页面、覆盖内容、四层上下文、扩展检查、宿主验证及源码/文档差异,不自动提交、推送或发布。

Signals

GitHub stars
3k
Forks
678
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
zuix-doc
Source
github.com/easysoft/zui