SuperAPI AI 工具集

seed-write-lynx-component-docs

前端与建站

查看项目

更新于 10-15 20:30

技能介绍

用途:为 SEED 编写或修改 Lynx 组件文档与可运行示例,使其与同一组件的 React 文档保持一致,并明确部署路径与兼容性。

主要能力与做法:

  • 对齐 React 文档:尽量维持相同的章节顺序、示例标题、场景与用户可见结果;仅当 Lynx 运行时有差异时才修改并说明理由。
  • 确定部署路径:依据 Registry 与 package export,区分 Registry 部署、package-only、package+Registry 三种方式,分别使用 Registry 安装路径或 @seed-design/lynx-react 的真实公开 export;不假设存在不存在的 Registry 安装步骤。
  • 兼容性核实:用 find-refer 查本地官方资料快照,参考 lynx-api-docs 确认 API 与 Engine 兼容性,lynx-check-css-support 确认 CSS 属性和值。

必要用法:先读仓库根及各路径 AGENTS.md(文档 docs/AGENTS.md、示例 docs/examples/lynx/AGENTS.md、预览构建 docs/scripts/lynx-examples/AGENTS.md);用 seed-component-map 定位目标 export、Registry、文档与示例;API 差异影响文档结构时使用 seed-api-parity。

验证与限制:在文档开发服务器或 docs/out 的 LynxComponentExample 中查看浏览器预览;新增原生结果声明或改动示例行为时,需在可用的 Lynx 宿主应用或 examples/lynx-spa 中实机验证。环境不可用时须报告未验证范围,不得添加绕过实现。不要用独立 HTML、临时 Vite 应用或临时 React 页面替代。QR 码须使用可直接访问的 .lynx.bundle HTTP(S) 地址,lynx:// 深链仅用于 Explorer 运行按钮;共享样式先于组件注册,示例中不要重复导入组件自有的 Recipe CSS。具体命令与脚本原文未提供。