Revamp documentation structure in mkdocs.yml by reorganizing navigation for improved accessibility. Remove outdated content from previous sections and introduce new topics including detailed guides on assistant management, configuration options, and tool integrations. Enhance API reference documentation with comprehensive error codes and WebSocket protocol details. Add new sections for automated testing, data analysis, and knowledge base management, ensuring a cohesive and user-friendly documentation experience.
This commit is contained in:
@@ -7,17 +7,84 @@ docs_dir: "content"
|
||||
site_dir: "site"
|
||||
|
||||
nav:
|
||||
- 首页: "index.md"
|
||||
- 快速开始: "getting-started.md"
|
||||
- 功能介绍:
|
||||
- 仪表盘: "features/dashboard.md"
|
||||
- 助手管理: "features/assistants.md"
|
||||
- 工作流: "features/workflows.md"
|
||||
- 模型配置: "features/models.md"
|
||||
- 知识库: "features/knowledge.md"
|
||||
- 历史记录: "features/history.md"
|
||||
- 自动化测试: "features/autotest.md"
|
||||
- 语音合成: "features/voices.md"
|
||||
- 部署指南: "deployment.md"
|
||||
- 首页: index.md
|
||||
- 快速开始:
|
||||
- 概览: quickstart/index.md
|
||||
- 通过控制台: quickstart/dashboard.md
|
||||
- 通过 API: quickstart/api.md
|
||||
- 安装部署:
|
||||
- 概览: getting-started/index.md
|
||||
- 环境要求: getting-started/requirements.md
|
||||
- 配置说明: getting-started/configuration.md
|
||||
- 助手管理:
|
||||
- 概览: assistants/index.md
|
||||
- 配置选项: assistants/configuration.md
|
||||
- 提示词指南: assistants/prompts.md
|
||||
- 测试调试: assistants/testing.md
|
||||
- 功能定制:
|
||||
- 知识库: customization/knowledge-base.md
|
||||
- 工具集成: customization/tools.md
|
||||
- 语音配置: customization/voices.md
|
||||
- 模型配置: customization/models.md
|
||||
- 工作流: customization/workflows.md
|
||||
- 数据分析:
|
||||
- 仪表盘: analysis/dashboard.md
|
||||
- 历史记录: analysis/history.md
|
||||
- 效果评估: analysis/evaluation.md
|
||||
- 自动化测试: analysis/autotest.md
|
||||
- API 参考:
|
||||
- WebSocket: "api-reference.md"
|
||||
- 概览: api-reference/index.md
|
||||
- WebSocket 协议: api-reference/websocket.md
|
||||
- 错误码: api-reference/errors.md
|
||||
- 部署指南:
|
||||
- 概览: deployment/index.md
|
||||
- Docker 部署: deployment/docker.md
|
||||
- 生产环境: deployment/production.md
|
||||
- 资源:
|
||||
- 常见问题: resources/faq.md
|
||||
- 故障排查: resources/troubleshooting.md
|
||||
|
||||
theme:
|
||||
name: material
|
||||
language: zh
|
||||
palette:
|
||||
- scheme: default
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: 切换到深色模式
|
||||
- scheme: slate
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: 切换到浅色模式
|
||||
features:
|
||||
- navigation.instant
|
||||
- navigation.tracking
|
||||
- navigation.tabs
|
||||
- navigation.sections
|
||||
- navigation.expand
|
||||
- toc.follow
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- content.code.copy
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- tables
|
||||
- attr_list
|
||||
- md_in_html
|
||||
|
||||
plugins:
|
||||
- search:
|
||||
lang: zh
|
||||
|
||||
Reference in New Issue
Block a user