documentation/sidebarsTheolive.ts at main · yichen-dlb/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 channelsApiSidebar from './theolive/api/channels/sidebar';
import eventsApiSidebar from './theolive/api/events/sidebar';
import reportsApiSidebar from './theolive/api/reports/sidebar';
import schedulersApiSidebar from './theolive/api/schedulers/sidebar';
import webhooksApiSidebar from './theolive/api/webhooks/sidebar';

const sidebars: SidebarsConfig = {
  theolive: [
    'index',
    'getting-started',
    {
      type: 'category',
      label: 'Contribution',
      customProps: {
        icon: '📡',
      },
      description: 'THEOlive Contribution / Publishing guides',
      link: { type: 'generated-index', slug: 'contribution' },
      items: [{ type: 'autogenerated', dirName: 'contribution' }],
    },
    {
      type: 'category',
      label: 'Platform',
      customProps: {
        icon: '📖',
      },
      description: 'THEOlive Platform guides',
      link: { type: 'generated-index', slug: 'platform' },
      items: [{ type: 'autogenerated', dirName: 'platform' }],
    },
    {
      type: 'category',
      label: 'Playback',
      customProps: {
        icon: '▶️',
      },
      description: 'THEOlive Playback / Player guides',
      link: { type: 'generated-index', slug: 'playback' },
      items: [{ type: 'autogenerated', dirName: 'playback' }],
    },
    'troubleshooting',
    {
      type: 'html',
      value: '<hr />',
    },
    {
      type: 'doc',
      id: 'contribution/hardware-encoders/index',
    },
    {
      type: 'doc',
      id: 'contribution/software-encoders/index',
    },
    {
      type: 'link',
      label: 'THEOlive REST API',
      customProps: {
        icon: '🛜',
      },
      href: '/theolive/api/',
    },
  ],
  theoLiveApi: [
    {
      type: 'link',
      label: '« Back',
      href: '/theolive/',
    },
    'api/index',
    {
      type: 'category',
      label: 'Channel API',
      collapsible: true,
      collapsed: false,
      items: channelsApiSidebar.slice(1),
    },
    {
      type: 'category',
      label: 'Events API',
      collapsible: true,
      items: eventsApiSidebar[1].items,
    },
    {
      type: 'category',
      label: 'Reports API',
      collapsible: true,
      items: reportsApiSidebar[1].items,
    },
    {
      type: 'category',
      label: 'Schedulers API',
      collapsible: true,
      items: schedulersApiSidebar[1].items,
    },
    {
      type: 'category',
      label: 'Webhooks API',
      collapsible: true,
      items: webhooksApiSidebar[1].items,
    },
  ],
};

export default sidebars;