mkdocs.yml

# TeleFuser Documentation Site Configuration
# Build (includes Cookbook): python scripts/docs/prepare_cookbook.py build
# Serve: python scripts/docs/prepare_cookbook.py serve
# Deploy: mkdocs gh-deploy --config-file .build/mkdocs.yml --force (after build)

site_name: TeleFuser
site_description: A streaming inference and serving framework for real-time world models and multimodal generation
site_author: TeleAI Team
site_url: https://tele-ai.github.io/TeleFuser

# Repository
repo_name: Tele-AI/TeleFuser
repo_url: https://github.com/Tele-AI/TeleFuser
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2024-2026 TeleAI Team

# Theme
theme:
  name: material
  language: en
  palette:
    # Dark mode
    - scheme: slate
      primary: deep orange
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Light mode
    - scheme: default
      primary: grey
      accent: grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - toc.follow
    - toc.integrate
  icon:
    repo: fontawesome/brands/github

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

  # Python Markdown Extensions
  - 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.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      dedent_subsections: true
  - 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

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3.2.2/es5/tex-mml-chtml.js

# Plugins
plugins:
  - search:
      lang:
        - en
        - zh
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 首页
            Get Started: 开始使用
            Installation: 安装
            Core WebRTC Experience: WebRTC 核心体验
            Basic Inference: 基础推理
            Models & Cookbook: 模型与 Cookbook
            Supported Models: 支持的模型
            Serving & APIs: 服务与 API
            Batch Service and API Reference: 批量服务与 API 参考
            Runtime & Optimization: 运行时与优化
            Operations & Reference: 运维与参考
            Troubleshooting: 故障排查
            Technical Blog: 技术博客
            Overview: 总览
            FP8 Sol-Attn: FP8 Sol-Attn
            Agent Dev First: Agent Dev First
            CUDA IPC Ulysses: CUDA IPC Ulysses
            Parallel Inference: 并行推理
            Communication Architecture: 通信架构
            Hardware Platforms: 硬件平台
            Developer Guide: 开发者指南
            Configuration: 配置
            Tools: 工具
            Service: 服务指南
            World Model Streaming Inference: 世界模型流式推理
            Stream Server: 流式服务
            Stream Scheduler: 流式调度器
            TeleFuser and AIPerf: TeleFuser 与 AIPerf
            Service Metadata: 服务元数据
            Quantization: 量化
            Adding New Example: 新增示例
            Model Loading: 模型加载
            TF-Kernel: TF-Kernel
            CPU Offloading: CPU卸载
            Attention: 注意力机制
            Feature Cache: 特征缓存
            Latent Cache: 潜空间缓存
            Adding New Model: 新增模型
            Adding New Stage: 新增阶段
            Publishing Cookbook Guides: 发布 Cookbook 指南
            Hash Config Management: 哈希配置管理
            torch.compile Compatibility: torch.compile兼容性
            Testing: 测试
            Profiler: 性能分析
            Metrics: 监控指标
            Logging: 日志
            Ops: 操作算子
  - git-revision-date-localized:
      enable_creation_date: true
      type: datetime
  - minify:
      minify_html: true
  - glightbox:
      auto_caption: true

# Navigation (locale-neutral paths resolved by i18n plugin)
nav:
  - Home: index.md
  - Get Started:
      - Overview: getting_started.md
      - Installation: installation.md
      - Core WebRTC Experience: streaming_quickstart.md
      - Basic Inference: quickstart.md
  - Models & Cookbook:
      - Supported Models: supported_models.md
  - Serving & APIs:
      - Overview: serving.md
      - Batch Service and API Reference: service.md
      - Stream Server: stream_server.md
      - Service Metadata: service_metadata.md
  - Runtime & Optimization:
      - World Model Streaming Inference: world_model_streaming_inference.md
      - Stream Scheduler: stream_scheduler.md
      - Configuration: configuration.md
      - Model Loading: model_loading.md
      - Parallel Inference: parallel.md
      - Communication Architecture: communication.md
      - Hardware Platforms: platforms.md
      - Attention: attention.md
      - Quantization: quantization.md
      - Feature Cache: feature_cache.md
      - Latent Cache: latent_cache.md
      - TF-Kernel: tf_kernel.md
      - CPU Offloading: offload.md
  - Operations & Reference:
      - Overview: operations_reference.md
      - Metrics: metrics.md
      - Logging: logging.md
      - Profiler: profiler.md
      - TeleFuser and AIPerf: benchmark_aiperf.md
      - Troubleshooting: troubleshooting.md
  - Developer Guide:
      - Publishing Cookbook Guides: cookbook_authoring.md
      - Adding New Example: adding_new_example.md
      - Adding New Model: adding_new_model.md
      - Adding New Stage: adding_new_stage.md
      - Ops: ops.md
      - Hash Config Management: hash_config_management.md
      - torch.compile Compatibility: torch_compile_compatibility.md
      - Testing: testing.md
  - Technical Blog:
      - Overview: blog/index.md
      - FP8 Sol-Attn: blog/fp8_sol_attention.md
      - Agent Dev First: blog/agent_dev_first_minimax_h3.md
      - CUDA IPC Ulysses: blog/cuda_ipc_ulysses.md

# Extra
extra:
  alternate:
    - name: English
      link: /TeleFuser/
      lang: en
    - name: 中文
      link: /TeleFuser/zh/
      lang: zh
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: Thanks for your feedback! Help us improve by opening an issue.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Tele-AI/TeleFuser
      name: GitHub

extra_css:
  - stylesheets/extra.css

# Strict mode - warns about broken links
strict: false