SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-16 06:47

技能介绍

用途:为 microsoft/fast 项目的贡献者和开发者补充、维护文档。文档分为三类:代码注释;由 Markdown 文件组成、描述代码流程与核心概念的设计/架构文档(如 DESIGN.md);以及文档网站。

主要能力与要求:设计/架构文档(如 DESIGN.md)应始终保持最新。文档网站主要覆盖 @microsoft/fast-element 包,其他包视为次要内容,测试包或工具应拥有各自章节。网站使用 11ty 编写,主体为 Markdown 文件;修改时需确认网站已按可用的最新主版本进行扫描。文档按文件夹组织,若存在 1.x/2.x/3.x 文件夹,应更新 3.x 文件夹中的文档。若进行破坏性变更,需确保迁移文档已更新。除包/ crate 级别的 DESIGN.md 外,所有 Markdown 文档都位于该包/crate 的 docs 文件夹中。为网站创建的文档应以实现该包的开发者为目标读者,不面向其他受众。

限制:资料未提供具体安装命令、配置步骤或使用示例,暂未提供。