SuperAPI AI 工具集

site-infra

写作与研究

查看项目

更新于 10-15 21:53

技能介绍

用途:维护 Capsem 的详细文档站点 docs.capsem.org。文档源文件为 Markdown/MDX,位于 web/docs/src/content/docs/,基于 Astro Starlight 编写。

主要能力与用法:本地开发用 cd web/docs && pnpm run dev(localhost:4321),构建校验用 cd web/docs && pnpm run build。CI 中 ci.yaml 在 pr-gate 下运行阻塞合并的 docs-build 任务;docs.yaml 仅在推送到 main 时部署并冒烟检查 https://docs.capsem.org/。新增页面时在对应分类目录创建 .md 并写 frontmatter(title、description,可选 sidebar.order),侧边栏通过 astro.config.mjs 的 autogenerate 自动生成;新增分类需在该配置中加 sidebar 条目。发布页路径为 releases/<major>-<minor>.md,用连字符,order 越大越新。图表用 mermaid 围栏代码块。图标源在 web/graphics/,favicon 由 1024w 彩色 logo 用 sips 命令生成。写作风格要求简洁、一页一主题、配置或测试用例优先用表格、必要时才给代码示例。

限制:Capsem 0.6 预发布期间生产构建不注册 Starlight 集成,仅发布 holding 页,并为每个原详细路由生成 noindex 墓碑页;不得删除或改写详细手册来生成 holding 页,被移除路径需显式替换。holding 页须说明 0.6 处于预发布资格验证阶段,不得提供安装说明或发布下载。恢复详细路由需在 0.6 文档获准发布后另行决定。多数页面仍为占位,需随功能稳定逐步补全。