Update documentation for Realtime Agent Studio with enhanced content and structure

- Revised site name and description for clarity and detail.
- Updated navigation structure to better reflect the organization of content.
- Improved changelog entries for better readability and consistency.
- Migrated assistant configuration and prompt guidelines to new documentation paths.
- Enhanced core concepts section to clarify the roles and capabilities of assistants and engines.
- Streamlined workflow documentation to provide clearer guidance on configuration and usage.
This commit is contained in:
Xin Wang
2026-03-09 05:38:43 +08:00
parent 65ae2287d5
commit b300b469dc
34 changed files with 1776 additions and 2981 deletions

View File

@@ -1,5 +1,5 @@
site_name: "Realtime Agent Studio"
site_description: "构建实时交互音视频智能体的开源工作平台"
site_name: "Realtime Agent Studio"
site_description: "Realtime Agent StudioRAS是一个通过管理控制台与 API 构建、部署和运营实时多模态助手的开源平台"
site_url: "https://your-org.github.io/AI-VideoAssistant"
copyright: "Copyright © 2025 RAS Team"
site_author: "RAS Team"
@@ -9,51 +9,45 @@ site_dir: "site"
nav:
- 首页: index.md
- 产品概览:
- 概述: overview/index.md
- 系统架构: overview/architecture.md
- 快速开始:
- 5 分钟入门: quickstart/index.md
- 资源库配置: quickstart/dashboard.md
- 核心概念:
- 概述: concepts/index.md
- 助手详解: concepts/assistants.md
- 引擎架构: concepts/engines.md
- 安装部署:
- 概述: getting-started/index.md
- 创建第一个助手: quickstart/index.md
- 环境与部署: getting-started/index.md
- 环境要求: getting-started/requirements.md
- 配置说明: getting-started/configuration.md
- 部署概览: deployment/index.md
- Docker 部署: deployment/docker.md
- 助手管理:
- 创建助手:
- 小助手:
- 配置选项: assistants/configuration.md
- 提示词指南: assistants/prompts.md
- 测试调试: assistants/testing.md
- 工作流:
- 配置选项: assistants/workflow-configuration.md
- 组件:
- 模型接入: customization/models.md
- 语音识别: customization/asr.md
- 语音生成: customization/tts.md
- 知识库: customization/knowledge-base.md
- 工具与插件: customization/tools.md
- 数据分析:
- 仪表盘: analysis/dashboard.md
- 历史记录: analysis/history.md
- 效果评估: analysis/evaluation.md
- 自动化测试: analysis/autotest.md
- API 参考:
- 概述: api-reference/index.md
- 构建助手:
- 助手概览: concepts/assistants.md
- 基础配置: concepts/assistants/configuration.md
- 提示词: concepts/assistants/prompts.md
- LLM 模型: customization/models.md
- 语音识别: customization/asr.md
- 声音资源: customization/voices.md
- TTS 参数: customization/tts.md
- 知识: customization/knowledge-base.md
- 工具: customization/tools.md
- 工作流: customization/workflows.md
- 测试与调试: concepts/assistants/testing.md
- 核心概念:
- 产品概览: overview/index.md
- 概念总览: concepts/index.md
- 引擎架构: concepts/engines.md
- Pipeline 引擎: concepts/pipeline-engine.md
- Realtime 引擎: concepts/realtime-engine.md
- 系统架构: overview/architecture.md
- 集成:
- API 参考: api-reference/index.md
- WebSocket 协议: api-reference/websocket.md
- 错误码: api-reference/errors.md
- 资源:
- 运维:
- 仪表盘: analysis/dashboard.md
- 历史记录: analysis/history.md
- 效果评估: analysis/evaluation.md
- 自动化测试: analysis/autotest.md
- 常见问题: resources/faq.md
- 故障排查: resources/troubleshooting.md
- 更新日志: changelog.md
- 路线图: roadmap.md
theme:
name: material
language: zh
@@ -148,7 +142,6 @@ plugins:
minify_html: true
extra:
# version.provider: mike — only enable when deploying with mike (versions.json is generated on deploy)
social:
- icon: fontawesome/brands/github
link: https://github.com/your-org/AI-VideoAssistant
@@ -164,3 +157,4 @@ extra_css:
extra_javascript:
- javascripts/mermaid.mjs
- javascripts/extra.js