AI-VideoAssistant/docs/mkdocs.yml

site_name: "Realtime Agent Studio"
site_description: "Realtime Agent Studio（RAS）是一个通过管理控制台与 API 构建、部署和运营实时多模态助手的开源平台。"
site_url: "https://your-org.github.io/AI-VideoAssistant"
copyright: "Copyright © 2025 RAS Team"
site_author: "RAS Team"

docs_dir: "content"
site_dir: "site"

nav:
  - 首页: index.md
  - 快速开始:
      - 环境与部署: getting-started/index.md
      - 创建第一个助手: quickstart/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
  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
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:
  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/mermaid.mjs
  - javascripts/extra.js