omni-livekit/mkdocs.yml at main · plexusone/omni-livekit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
site_name: omni-livekit Documentation
site_description: LiveKit provider for OmniMeet and OmniVoice
site_author: PlexusOne
site_url: https://plexusone.github.io/omni-livekit/

repo_name: plexusone/omni-livekit
repo_url: https://github.com/plexusone/omni-livekit

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (PlexusOne default)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

extra_css:
  - https://plexusone.dev/css/plexusone-mkdocs.css

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started.md
      - Quick Start: quickstart.md
  - Guides:
      - Human Participation: guides/human-participation.md
      - Voice Agent: guides/voice-agent.md
      - Avatar Providers: guides/avatar-providers.md
      - Tavus Avatars: guides/tavus-avatars.md
      - OmniMeet Integration: guides/omnimeet-integration.md
  - Architecture:
      - Voice Pipeline: architecture/voice-pipeline.md
      - Static Image Avatar: architecture/avatar.md
  - Design:
      - Lip-Sync Avatars:
          - Product Requirements: architecture/avatars/PRD.md
          - Technical Design: architecture/avatars/TRD.md
          - Implementation Plan: architecture/avatars/PLAN.md
          - Roadmap: architecture/avatars/ROADMAP.md
          - Gap Analysis: architecture/avatars/PHASE0_GAP_ANALYSIS.md
  - API Reference:
      - Gateway: api/gateway.md
      - Room Client: api/room.md
      - Agent: api/agent.md
      - Avatar: api/avatar.md
  - Releases:
      - Overview: releases/index.md
      - v0.5.0: releases/v0.5.0.md
      - v0.4.0: releases/v0.4.0.md
      - v0.3.0: releases/v0.3.0.md
      - v0.2.0: releases/v0.2.0.md
      - v0.1.0: releases/v0.1.0.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/plexusone