SuperAPI AI 工具集

write-lynx-component-docs

设计与创作

查看项目

更新于 10-15 20:04

技能介绍

用途:在 SEED Design 仓库中撰写、修改、调试 Lynx 组件文档与可运行示例,使文档与示例符合仓库规则,并明确文档工作与运行时实现变更的边界。\n\n主要能力:\n- 编写符合规范的 Lynx 组件文档与示例,包含 Engine 与 XElement 兼容性 frontmatter、MDX 与示例入口。\n- 通过 LynxComponentExample 在文档开发服务器与 docs/out 中预览 WebLynx 效果。\n- 依据组件源码、官方 Lynx API 文档与 Lynx Compatibility Data 确认最低 Engine 版本与所用 XElement,不靠推测。\n- 对问题分类:文档表达问题、示例与预览环境问题、组件与运行时问题,并分别在对应范围内处理。\n- 网络与原生结果不一致时定位成因;原生专属行为尽量在 Lynx Explorer 或 PlayLynx 验证,缺少设备或会话时如实报告环境阻塞而非写绕过实现。\n\n使用方式要点:\n- 先阅读仓库根目录与工作路径下的 AGENTS.md;改文档页读 docs/AGENTS.md,改示例读 docs/examples/lynx/AGENTS.md,改预览构建或清单读 docs/scripts/lynx-examples/AGENTS.md。\n- 参照同一组件的 React 文档与示例确定章节结构、场景与展示行为,并与相近 Lynx 组件对比确定平台转换方式。\n- 示例只使用 @seed-design/lynx-react 的公开导出,且呈现宿主应用推荐用法。\n- 状态输出中可能不被 JSX 显示的值用 JSON.stringify 序列化;共享样式先于组件注册,示例不重复引入组件自有的 recipe CSS。\n- QR 码使用可直接访问的 .lynx.bundle HTTP(S) 地址,lynx:// 深链仅用于 Explorer 启动按钮。\n\n限制:不应为迁就 Web 预览限制而改动发布组件;不将 WebLynx 示例移到独立 HTML、独立 Vite 应用或临时 React 页面;不模仿未支持的功能;不添加仅供文档的例外。源资料未提供具体安装命令、定价与完整代码示例。