SuperAPI AI 工具集

pie-docs-authoring

通用与其它

查看项目

更新于 10-15 23:43

技能介绍

该技能用于在 PIE 文档站点 apps/pie-docs 中创建或编辑内容,包括页面、导航分区以及组件、模式等标签式页面,也涉及首页索引内容与草稿标记。

所有编写规范的唯一权威来源是 apps/pie-docs/AUTHORING_GUIDE.md,动笔前须完整阅读,不要在此重复或转述其规则,以确保指导不会偏离。该文件同时作为 GitHub Copilot 的审查指令依据。

工作流:先完整阅读 AUTHORING_GUIDE.md,再按任务跳到对应章节——新增顶级导航分区看“Creating a new navigation section”;新增组件、模式或基础页面看“Creating tabbed pages”;为导航项添加落地内容看“Adding index pages”;标记页面或分区尚未可用于生产看“Drafts”;任何措辞、frontmatter、shortcode 或链接问题看“Conventions and quality rules”。随后严格按指南的示例与规则编写或修改内容。

发布前需按指南的“Conventions and quality rules”逐项核对,并特别自查两类不会报错的静默规则:导航 parent/key 与 .json 中的 navKey 是否匹配;ogImage、image src 与索引卡片文件是否真实存在于磁盘;indexPageDisplay 的 itemKey 是否与分区 key 完全一致。然后运行生产构建检查,使用 AGENTS.md 中的 Turborepo 命令,不要 cd 进入应用目录: yarn build --filter=@justeattakeaway/pie-docs 构建须无错误完成,再检查 apps/pie-docs/dist/:新页面的 index.html 存在于预期路径,且未因草稿被丢弃;新条目出现在已构建页面的导航标记中。若新增或删除了页面,需重新生成路由快照,否则过期的 expected-routes.snapshot.json 会导致导航测试失败: yarn test:generate-routes --filter=@justeattakeaway/pie-docs

限制与说明:上述路径均相对仓库根目录;若技能内容与指南冲突,以指南为准并更新技能;资料未提供收费等信息。