documentation/sidebarsTheolive.ts at main · THEOplayer/documentation · 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
import apiSidebar from './theolive/api/sidebar';

const sidebars: SidebarsConfig = {
  theolive: [
    'index',
    'getting-started',
    'manage-team',
    'architecture',
    {
      type: 'category',
      label: 'Channel',
      customProps: {
        icon: '📺',
      },
      description: 'Configure channel-level settings and optional features.',
      link: {
        type: 'generated-index',
        slug: 'channel',
        description:
          'A channel is the core building block of the platform — it represents a complete live streaming pipeline from media ingestion through to viewer delivery. Each channel is composed of ingests, engines, and distributions. This section covers settings configured at the channel level. See the Architecture page for the full breakdown.',
      },
      items: [{ type: 'autogenerated', dirName: 'channel' }],
    },
    {
      type: 'category',
      label: 'Ingest',
      customProps: {
        icon: '📡',
      },
      description: 'Get your live media into the platform.',
      link: { type: 'generated-index', slug: 'contribution' },
      items: [{ type: 'autogenerated', dirName: 'contribution' }],
    },
    {
      type: 'category',
      label: 'Media Engine',
      customProps: {
        icon: '⚙️',
      },
      description: 'How your stream is processed and packaged for delivery.',
      link: { type: 'generated-index', slug: 'media-engine' },
      items: [{ type: 'autogenerated', dirName: 'media-engine' }],
    },
    {
      type: 'category',
      label: 'Distribution',
      customProps: {
        icon: '📤',
      },
      description: 'Control how and where your stream reaches viewers.',
      link: { type: 'generated-index', slug: 'distribution' },
      items: [{ type: 'autogenerated', dirName: 'distribution' }],
    },
    {
      type: 'category',
      label: 'Playback',
      customProps: {
        icon: '▶️',
      },
      description: 'Integrate the player into your app or website.',
      link: { type: 'doc', id: 'playback/optiview-player' },
      items: [{ type: 'autogenerated', dirName: 'playback' }],
    },
    {
      type: 'category',
      label: 'Platform',
      customProps: {
        icon: '📖',
      },
      description: 'THEOlive Platform guides',
      link: { type: 'generated-index', slug: 'platform' },
      items: [{ type: 'autogenerated', dirName: 'platform' }],
    },
    'troubleshooting',
    {
      type: 'html',
      value: '<hr />',
    },
    {
      type: 'link',
      label: 'REST API',
      customProps: {
        icon: '🛜',
      },
      href: '/theolive/next/api/',
    },
    'changelog',
    'api/migration-from-v1',
  ],
  theoLiveApi: [
    {
      type: 'link',
      label: '« Back',
      href: '/theolive/next/',
    },
    'api/index',
    'api/authentication',
    'api/pagination',
    'api/full-example',
    ...apiSidebar.slice(1),
  ],
};

export default sidebars;