From 95e04d8c942721e02c83e498b63e493c4523f835 Mon Sep 17 00:00:00 2001 From: Xin Wang Date: Fri, 7 Aug 2026 11:09:10 +0800 Subject: [PATCH] Split Mintlify docs into user and developer sections. Organize product guides under docs/user and setup/integration under docs/developer, with tabbed navigation for clearer audience targeting. Co-authored-by: Cursor --- docs/{ => developer}/integrations.mdx | 0 docs/{ => developer}/quickstart.mdx | 0 docs/docs.json | 24 +++++++++++++++++++----- docs/index.mdx | 26 +++++++++----------------- docs/{ => user}/features.mdx | 0 docs/user/overview.mdx | 22 ++++++++++++++++++++++ 6 files changed, 50 insertions(+), 22 deletions(-) rename docs/{ => developer}/integrations.mdx (100%) rename docs/{ => developer}/quickstart.mdx (100%) rename docs/{ => user}/features.mdx (100%) create mode 100644 docs/user/overview.mdx diff --git a/docs/integrations.mdx b/docs/developer/integrations.mdx similarity index 100% rename from docs/integrations.mdx rename to docs/developer/integrations.mdx diff --git a/docs/quickstart.mdx b/docs/developer/quickstart.mdx similarity index 100% rename from docs/quickstart.mdx rename to docs/developer/quickstart.mdx diff --git a/docs/docs.json b/docs/docs.json index 296a095..6b0f5a5 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -43,14 +43,28 @@ } }, "navigation": { - "groups": [ + "tabs": [ { - "group": "开始使用", - "pages": ["index", "quickstart"] + "tab": "首页", + "pages": ["index"] }, { - "group": "产品与对接", - "pages": ["features", "integrations"] + "tab": "用户文档", + "groups": [ + { + "group": "产品", + "pages": ["user/overview", "user/features"] + } + ] + }, + { + "tab": "开发者文档", + "groups": [ + { + "group": "开始与对接", + "pages": ["developer/quickstart", "developer/integrations"] + } + ] } ] } diff --git a/docs/index.mdx b/docs/index.mdx index 849dc52..e340b03 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,26 +1,18 @@ --- -title: AI 视频助手 -description: 面向实时语音交互的助手管理与集成平台。 -icon: video +title: 文档首页 +description: 按读者区分的用户文档与开发者文档入口。 +icon: book-open --- -# AI 视频助手 +# 文档首页 -在一个界面中配置模型、知识库、工具和助手,并通过 WebRTC 或 WebSocket 接入实时语音对话。 +本站点按读者分成两套文档: - - 本地启动服务并完成首次助手配置。 + + 产品能力与配置关系,适合运营与配置人员。 - - 了解模型、外部 Agent 与语音通道的接入方式。 + + 本地启动、模型对接与语音通道,适合开发与集成。 - -## 平台组成 - -- **助手**:定义提示词、运行模式、模型绑定及可选工作流。 -- **组件库**:统一维护模型资源、知识库和可复用工具。 -- **语音引擎**:Pipecat 管线支持浏览器 WebRTC 与裸 WebSocket 音频流。 - -> 凭证只保存在模型资源或助手的服务端配置中;接口返回会自动打码。 diff --git a/docs/features.mdx b/docs/user/features.mdx similarity index 100% rename from docs/features.mdx rename to docs/user/features.mdx diff --git a/docs/user/overview.mdx b/docs/user/overview.mdx new file mode 100644 index 0000000..c7d4207 --- /dev/null +++ b/docs/user/overview.mdx @@ -0,0 +1,22 @@ +--- +title: 产品概览 +description: 面向实时语音交互的助手管理与集成平台。 +icon: video +--- + +# 产品概览 + +在一个界面中配置模型、知识库、工具和助手,并通过 WebRTC 或 WebSocket 接入实时语音对话。 + +## 平台组成 + +- **助手**:定义提示词、运行模式、模型绑定及可选工作流。 +- **组件库**:统一维护模型资源、知识库和可复用工具。 +- **语音引擎**:Pipecat 管线支持浏览器 WebRTC 与裸 WebSocket 音频流。 + +> 凭证只保存在模型资源或助手的服务端配置中;接口返回会自动打码。 + +## 下一步 + +- [核心功能](/user/features):了解助手类型、模型、知识库与工具。 +- 本地启动与对接细节见 [开发者文档](/developer/quickstart)。