4c05131536
- Revised mkdocs.yml to reflect the new site name and description, enhancing clarity for users. - Added a changelog.md to document important changes and updates for the project. - Introduced a roadmap.md to outline development plans and progress for future releases. - Expanded index.md with a comprehensive overview of the platform, including core features and installation instructions. - Enhanced concepts documentation with detailed explanations of assistants, engines, and their configurations. - Updated configuration documentation to provide clear guidance on environment setup and service configurations. - Added extra JavaScript for improved user experience in the documentation site.
171 lines
4.4 KiB
YAML
171 lines
4.4 KiB
YAML
site_name: "Realtime Agent Studio"
|
|
site_description: "构建实时交互音视频智能体的开源工作平台"
|
|
site_url: "https://your-org.github.io/AI-VideoAssistant"
|
|
repo_name: "AI-VideoAssistant"
|
|
repo_url: "https://github.com/your-org/AI-VideoAssistant"
|
|
copyright: "Copyright © 2025 RAS Team"
|
|
site_author: "RAS Team"
|
|
|
|
docs_dir: "content"
|
|
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
|
|
- 环境要求: 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 参考:
|
|
- 概述: 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
|
|
- 更新日志: changelog.md
|
|
- 路线图: roadmap.md
|
|
|
|
theme:
|
|
name: material
|
|
language: zh
|
|
custom_dir: overrides
|
|
icon:
|
|
logo: material/robot-outline
|
|
font:
|
|
text: Inter
|
|
code: JetBrains Mono
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: 切换到深色模式
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: 切换到浅色模式
|
|
features:
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.path
|
|
- navigation.top
|
|
- navigation.footer
|
|
- toc.follow
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tabs.link
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.magiclink:
|
|
repo_url_shorthand: true
|
|
user: your-org
|
|
repo: AI-VideoAssistant
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
plugins:
|
|
- search:
|
|
lang: zh
|
|
separator: '[\s\-\.]+'
|
|
- minify:
|
|
minify_html: true
|
|
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/your-org/AI-VideoAssistant
|
|
name: GitHub
|
|
generator: false
|
|
analytics:
|
|
provider: google
|
|
property: G-XXXXXXXXXX
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
extra_javascript:
|
|
- javascripts/extra.js
|