用途:为 Abacus 文档站点(基于 Astro Starlight)创建和维护文档页面,包括新增文档、更新现有页面,以及保持文档同步。
主要能力与工作方式:
- 开始前先阅读 docs/src/content/docs/ 下的现有页面以理解写作模式,查看 docs/astro.config.mjs 了解侧边栏结构,并确认所写内容所属分区(getting-started、providers、cli、deployment、development)。
- 新增页面:在对应目录创建 .mdx 文件,添加必需 frontmatter,参考现有页面使用组件,然后运行 cd docs && pnpm build 校验。
- 更新页面:先阅读当前页面,修改时保留既有模式,再运行 cd docs && pnpm build 校验。
必需 frontmatter:每页需要 title、description(用于 SEO 的一行描述)以及 sidebar.order(在分区内的位置)。
关键规则:
- 内部链接必须带基础路径 /abacus/ 前缀(GitHub Pages 要求),例如正确写法 Quick Start,错误写法 Quick Start。
- 使用组件前先导入:import { Steps, Aside } from '@astrojs/starlight/components';,再使用 <Steps> 与 <Aside type="tip"> 等。
- 代码块必须带语言标签,例如 ```bash 后接 pnpm cli sync。
提交前始终运行 cd docs && pnpm build 校验。常见错误包括缺少导入、frontmatter 无效、链接失效(路径错误或缺少 /abacus/)。
写作风格:使用祈使语气(“Run this”而非“You should run”);优先给出代码示例而非抽象描述;段落保持简短便于浏览;环境变量、选项等参考数据使用表格。
限制:以上为资料中明确提供的内容,未提供部分(如具体安装依赖、更多组件说明或平台兼容性细节)暂未提供。