voxbento/sidebars.ts at main · fossasia/voxbento · 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
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

const sidebars: SidebarsConfig = {
  tutorialSidebar: [
    {
      type: 'category',
      label: 'Documentation',
      link: {
        type: 'generated-index',
        title: 'Documentation',
        description: 'Get started with Voxbento',
        slug: '/documentation',
      },
      items: [
        {
          type: 'category',
          label: 'Get Started',
          items: ['introduction', 'quickstart', 'how-it-works'],
        },
        {
          type: 'category',
          label: 'Admin Guide',
          items: [
            'admin/events-and-rooms',
            'admin/booths',
            'admin/members-and-roles',
            'admin/invite-tokens',
            'admin/transcription',
          ],
        },
        {
          type: 'category',
          label: 'Interpreter Guide',
          items: [
            'interpreter/joining-a-booth',
            'interpreter/going-live',
            'interpreter/handoff',
          ],
        },
        {
          type: 'category',
          label: 'Listener Guide',
          items: ['listener/attending-an-event', 'listener/live-captions'],
        },
        {
          type: 'category',
          label: 'Configuration',
          items: [
            'configuration/environment-variables',
            'configuration/deployment',
            'configuration/security',
          ],
        },
      ],
    },
    {
      type: 'category',
      label: 'API Reference',
      link: {
        type: 'generated-index',
        title: 'API Reference',
        description: 'Voxbento API documentation',
        slug: '/api',
      },
      items: [
        {
          type: 'category',
          label: 'Overview',
          items: ['api/overview', 'api/authentication'],
        },
        {
          type: 'category',
          label: 'Booths',
          items: ['api/booths/state', 'api/booths/whip-whep', 'api/booths/events'],
        },
        {
          type: 'category',
          label: 'Real-Time',
          items: ['api/websocket/booth', 'api/websocket/captions'],
        },
      ],
    },
  ],
};

export default sidebars;