SuperAPI AI 工具集

write-docs

通用与其它

查看项目

更新于 10-16 03:37

技能介绍

用途:指导编写、更新和测试 Prefect 文档页面,适用于新建文档页、修改现有文档或使用 Mintlify 组件时。

主要能力:按页面类型组织内容,包括 Get Started(线性引导)、Concepts(概念与心智模型)、How-to Guides(面向任务,按 workflows、deployments、deployment_infra、automations、cloud、configuration、ai、migrate、self-hosted 分类)、Advanced、Examples、Integrations、API Reference、Release Notes、Contribute。说明何时更新现有页面、何时新建页面或分类,并提供 how-to 与 concept 模板。

使用方式:新页面需在 frontmatter 添加 3-5 个小写 keywords,并在 docs/docs.json 的 navigation.tabs 中注册路径(不含 .mdx),否则不会出现在侧边栏;移动或重命名页面需添加重定向。使用 Mintlify 组件(Note、Warning、Tip、Info、Accordion、Tabs、Steps、CardGroup、CodeGroup)而非 Markdown 提示语法。复用 snippets/ 中的片段,如 installation.mdx 与 resource-management/。

代码测试:.mdx 中的 Python 代码块由 pytest-markdown-docs 自动提取执行,CI 中针对实时 Prefect server 并行运行。可用 {/* pmd-metadata: notest */} 跳过、continuation 共享状态、fixture:<name> 注入 fixture。本地运行:PREFECT_HOME=$(pwd) uv run prefect server start & 后执行 PREFECT_API_URL="http://127.0.0.1:4200/api" uv run --group markdown-docs pytest docs/ -m markdown-docs。无法测试的页面加入 conftest.py 的 SKIP_FILES。

风格与限制:使用第二人称、主动语态、现在时,避免第一人称与营销用语,遵循 Google 文档风格;用 just lint 或 vale --glob='**/*.{md,mdx}' . 检查。正文不用 H1,链接不用相对路径或 .mdx 后缀,注意术语大小写(Prefect Cloud、Prefect server、Kubernetes)。图片放 v3/img/ 并写有意义的 alt 文本。Examples 与 API Reference 为自动生成,不要直接编辑。