Merge pull request #8 from srsng/main

调整

Author: hyt1004

docs/.vitepress/config.mts

@@ -1,12 +1,13 @@
-import { defineConfig } from "vitepress";
+// import { defineConfig } from "vitepress";
+import { withMermaid } from "vitepress-plugin-mermaid";
 import { Chapters, getChapterItems } from "./theme/constrants/route";
 import autoH1 from "./plugins/autoH1";
 
 // 限制sidebar最多深入两层章节
 const sidebarItems = getChapterItems(1, 2);
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
+export default withMermaid({
   lang: "zh",
   title: "灵矽文档中心",
   description: "A 灵矽 Documentation Project",
@@ -22,7 +23,7 @@ export default defineConfig({
       { text: "API", link: Chapters.xrobot_api },
       { text: "MCP接入", link: Chapters.xrobot_mcp },
       { text: "最佳实践", link: Chapters.xrobot_guide },
-      { text: "FAQ", link: Chapters.xrobot_faq },
+      { text: "FAQ", link: Chapters.xrobot_faq + "faq/" },
     ],
     sidebar: sidebarItems,
     socialLinks: [
@@ -32,8 +33,8 @@ export default defineConfig({
       },
     ],
     search: {
-      provider: 'local',
-    }
+      provider: "local",
+    },
   },
   markdown: {
     toc: {

docs/.vitepress/theme/constrants/route.ts

@@ -76,8 +76,8 @@ const items_xrobot_platform = [
     link: Chapters.xrobot_platform,
     collapsed: true,
     items: [
-      { text: "OTA", link: "OTA" },
-      { text: "websocket", link: "websocket" },
+      { text: "OTA 网关", link: "OTA" },
+      { text: "WebSocket", link: "websocket" },
       { text: "MQTT", link: "MQTT" },
     ].map((item) => apply_prefix(item, Chapters.xrobot_platform)),
   },
@@ -105,9 +105,7 @@ const items_xrobot_mcp = [
     items: [
       // { text: "硬件MCP", link: "hardware-mcp" },
       // { text: "软件MCP", link: "software-mcp" },
-    ].map((item) =>
-      apply_prefix(item, Chapters.xrobot_mcp)
-    ),
+    ].map((item) => apply_prefix(item, Chapters.xrobot_mcp)),
   },
 ];
 

docs/.vitepress/theme/index.css

@@ -25,6 +25,11 @@
   margin: auto;
 }
 
+/* 主页 */
+div.home #local-search button {
+  display: none;
+}
+
 /* todo 移除测试背景-该背景被应用到整个页面 */
 /* div[class="VPContent is-home"] {
   background: linear-gradient(to bottom right, #dce8ff, #e4eeff, #e6cbfd);

docs/index.md

@@ -41,7 +41,7 @@ features:
       dark: /icons/dark/faq.svg
       width: 100
       height: 100
-    link: ./xrobot/faq
+    link: ./xrobot/faq/faq/
   - linkText: 去体验
     icon: 
       light: /icons/light/experience.svg

docs/xrobot/platform/OTA.md

@@ -1,5 +1,5 @@
 ---
-title: OTA 协议
+title: OTA 协议(网关)
 ---
 
 ## OTA（Over-The-Air）更新介绍

docs/xrobot/platform/websocket.md

@@ -37,11 +37,39 @@ WebSocket 协议的主要特点包括：
 1. 建立 WebSocket 连接
 2. 交换 hello 消息
 3. 开始语音交互:
-
-- 发送开始监听
-- 发送音频数据
-- 接收识别结果
-- 接收 TTS 音频 4.结束会话时关闭连接
+   - 发送开始监听
+   - 发送音频数据
+   - 接收识别结果
+   - 接收 TTS 音频
+4. 结束会话时关闭连接
+
+```mermaid
+sequenceDiagram
+    participant Client
+    participant Server
+
+    Client->>Server: 建立 WebSocket 连接 (wss://xrobo-io.qiniuapi.com/v1/ws/)
+    Note right of Client: 携带 headers: Authorization, Protocol-Version, Device-Id, Client-Id
+    Server-->>Client: 连接成功
+
+    Client->>Server: 发送 hello 消息
+    Note right of Client: JSON: {type: "hello", version: 1, transport: "websocket", audio_params: {...}}
+    Server-->>Client: 响应 hello 消息
+    Note left of Server: JSON: {type: "hello", transport: "websocket", audio_params: {...}}
+
+    Client->>Server: 发送开始监听消息
+    Note right of Client: JSON: {session_id: "<ID>", type: "listen", state: "start", mode: "<auto/manual/realtime>"}
+
+    Client->>Server: 发送 OPUS 音频数据 (二进制)
+    Server-->>Client: 返回语音识别结果
+    Server-->>Client: 发送 TTS 音频数据 (OPUS)
+    Note left of Server: JSON: {type: "tts", state: "<start/stop/sentence_start>", text: "<文本>"}
+
+    Client->>Server: 发送停止监听消息
+    Note right of Client: JSON: {session_id: "<ID>", type: "listen", state: "stop"}
+
+    Client->>Server: 关闭 WebSocket 连接
+```
 
 ### 连接建立
 

package.json

@@ -1,7 +1,9 @@
 {
   "devDependencies": {
+    "medium-zoom": "^1.0.6",
+    "mermaid": "^11.9.0",
     "vitepress": "^1.6.3",
-    "medium-zoom": "^1.0.6"
+    "vitepress-plugin-mermaid": "^2.0.17"
   },
   "scripts": {
     "docs:dev": "vitepress dev docs",