docs/sidebars.ts at master · layer-3/docs · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */
const sidebars: SidebarsConfig = {
  // Learn section sidebar
  learnSidebar: [
    {
      type: 'doc',
      id: 'learn/index',
      label: 'Learn',
    },
    {
      type: 'category',
      label: 'Introduction',
      items: [
        'learn/introduction/what-yellow-solves',
        'learn/introduction/architecture-at-a-glance',
        'learn/introduction/supported-chains',
      ],
      collapsible: false,
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Getting Started',
      items: [
        'learn/getting-started/quickstart',
        'learn/getting-started/prerequisites',
        'learn/getting-started/key-terms',
      ],
      collapsible: false,
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Core Concepts',
      items: [
        'learn/core-concepts/state-channels-vs-l1-l2',
        'learn/core-concepts/app-sessions',
        'learn/core-concepts/session-keys',
        'learn/core-concepts/challenge-response',
        'learn/core-concepts/message-envelope',
        'learn/core-concepts/yellow-token',
      ],
      collapsible: false,
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Protocol Flows',
      items: [
        {type: 'autogenerated', dirName: 'learn/protocol-flows'},
      ],
      collapsible: false,
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Advanced',
      items: [
        'learn/advanced/managing-session-keys',
      ],
      collapsible: false,
      collapsed: false,
    },
  ],

  // Build section sidebar
  buildSidebar: [
    {
      type: 'autogenerated',
      dirName: 'build',
    },
  ],

  // Tutorials section sidebar
  tutorialsSidebar: [
    {
      type: 'autogenerated',
      dirName: 'tutorials',
    },
  ],

  // Guides section sidebar
  guidesSidebar: [
    {
      type: 'autogenerated',
      dirName: 'guides',
    },
  ],

  // API Reference section sidebar
  apiSidebar: [
    {
      type: 'autogenerated',
      dirName: 'api-reference',
    },
  ],

  // Protocol section sidebar
  protocolSidebar: [
    {
      type: 'autogenerated',
      dirName: 'protocol',
    },
  ],

  // Default sidebar for standalone pages
  defaultSidebar: [
  ],
};

export default sidebars;