SuperAPI AI 工具集

creating-integration-docs

写作与研究

查看项目

更新于 10-16 01:33

技能介绍

用途:在 Nango 项目中新增或编辑集成文档,包括全新集成的文档,以及修改已有集成的主页面、设置指南或连接指南。不适用于文档迁移或一般性文档改动,迁移应使用 nango-docs-migrator 智能体。

主要能力:按固定结构生成文档文件。主页面位于 docs/api-integrations/[slug].mdx,含四步快速开始、指南链接与预构建同步区块;设置指南位于 docs/api-integrations/[slug]/how-to-register-your-own-[slug]-api-oauth-app.mdx,说明 OAuth 应用注册步骤;可选连接指南为 docs/api-integrations/[slug]/connect.mdx;同步片段位于 snippets/generated/[slug]/PreBuiltUseCases.mdx,可为自动生成或空状态;导航配置写入 docs/docs.json 的 "APIs & Integrations" 分组,提供方配置写入 packages/providers/providers.yaml,补充 docs 与 setup_guide_url(存在连接指南时加 docs_connect)。

使用方式:先收集集成名称、slug、认证类型(OAuth2、API Key、Basic Auth)、API 基础 URL、API 文档 URL 及 OAuth 凭据获取步骤。按模板创建上述文件,在 docs.json 中仅按字母顺序添加主页面路径,设置指南通过链接访问而非导航。文档规范见 docs/AGENTS.md:正文标题从 H2 开始,标题用句首大写;修改标题、路径或内部链接后需在 docs/ 下运行 mintlify broken-links 并确认无断链。API Key 或 Basic Auth 场景需相应调整设置指南标题,OAuth2 需标注回调地址 https://api.nango.dev/oauth/callback。

限制与注意:slug 须为小写加连字符;不得将设置指南加入 docs.json;需始终创建 PreBuiltUseCases 片段;常用错误包括链接格式错误、遗漏 providers.yaml 更新等。官方文档未提供该技能的安装命令、平台与收费信息。