跳转到主要内容

​
Documentation project instructions

​
About this project

  • This is a documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Product documentation lives under productions/<product>/: editable content is in preview/<language>/, and released snapshots are in archives/<version>/<language>/.
  • Use the Mintlify MCP server, https://mcp.mintlify.com, to edit content and settings via MCP
  • Use the Mintlify docs MCP server, https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP
完整的写作规范见仓库根目录的 SPEC.md。本节是供仓库协作环境加载的精简版；两者冲突时以 SPEC.md 为准。

​
Documentation skill

编写、改进或审查文档时，使用仓库内的 agentkit-docs-spec 技能。先读取根 SPEC.md 和对应产品规范，再按任务选读技能中的写作、页面结构、示例核验、双语和审查参考 根 SPEC.md 定义文档要求，产品规范补充各产品约定，技能提供执行方法与检查清单。发生冲突时以根 SPEC.md 为准；更新规范或技能时，同步核对相互引用与规则一致性

​
Product-specific specs

When editing product documentation under productions/<product>/preview/{zh,en}, read the root SPEC.md first, then read the matching product spec: The root SPEC.md has highest priority. Product-specific specs only add directory, page-type, formatting, examples, and verification rules for the corresponding Preview documentation. Do not use archives as the source of truth for new Preview content.

​
Terminology

  • 正文中的 “agent” 一律译为「智能体」；代码标识符、类名（Agent）与配置键（model.agent）保持原样。
  • 中文不要给术语附加括号内的译名/注解，标题同样：写「火山方舟」「Cozeloop」title: "A2UI"，而非「火山方舟（Ark）」title: "A2UI（智能体驱动 UI）"。无对应中文的技术标识（extras、RAG、Redis、API Key）保留英文。
  • 后端类文章标题用「使用 xxx 存储」，不附括号英文。

​
Style preferences

  • 采用书面、正式的中文，避免口语化。
  • 不要把提问或提示词原封不动搬进文档，一律以文档自身口吻重写。
  • 标题使用描述性短语，不用数字序号（不写 ## 1. 安装）。
  • YAML frontmatter 提供 title；HTTP API 单接口页面另提供 openapi，绑定对应语言的规范文件、方法和路径。保留并维护语言切换使用的 en_link / zh_link，不添加 description 或页面副标题。
  • 内容具体、完整：提到可选安装/配置时写清它包含什么；介绍可扩展点必须给出使用方法与示例。
  • 每个后端有独立、完整的说明（全部参数：名称、类型、默认值、说明 + 可运行示例）。命令行的所有子命令与标志用表格列出并配示例。
  • 避免源码级表述：不暴露内部文件名、内部函数名、私有机制、异常类型或构造参数字面量；以使用者视角描述行为。用户需直接使用的公开 API（类名、构造参数、配置键、环境变量、用户自建文件路径）应保留并写清。
  • 默认不添加「下一步」一类的收尾章节，除非明确要求。
  • 双语站点：中文默认，英文并列；两侧目录结构与页面层级保持一致，改动同步更新。
  • preview 用于下一版本的可编辑文档；archives 中的已发布版本只做对应版本的事实修正，不随 Preview 自动更新。
  • changelog.mdx 必须累计保留首个已发布版本至目标版本的全部公开变更，按版本从新到旧排列；新增版本不得覆盖或删除已有版本分节。
  • 更新前同步最新 main，并检查同一产品变更对应的开放、关闭和已合并文档 PR；已合并内容同样需要核对完整性。
  • 每次更新先列出命令/参数、配置、正文、示例、Changelog、中英文和导航的影响清单。Changelog 链接页必须实际说明对应能力。
  • Changelog 只描述相对目标基线的真实增量，不把已有能力重新写成“新增”；仅在 Preview 源码可用的能力必须注明范围、核验基线和公开源码安装方式，不能让稳定版示例看似可用。
  • 未发布能力只进入 Preview 的 未发布 / Unreleased 分节；创建归档前按目标 tag 核验，禁止把 tag 之后的能力复制进归档。
  • Preview 的通用示例不要固定到过期版本；固定版本号只用于明确的安装、兼容性或复现场景。
  • 对外分支名、提交信息、PR 正文和文档不得描述撰写工具、模型、执行环境或自动生成过程，只写用户价值、事实依据和验证结果。

​
Content boundaries

  • 文档面向使用者，不记录内部实现细节、源码走读或内部管理功能。
最后修改于 2026年10月20日