docs.waku.org/sidebars.js at develop · logos-messaging/docs.waku.org · 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
// @ts-check

/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
const sidebars = {
  build: [
    {
      type: "link",
      label: "Home",
      href: "/",
    },
    {
      type: "category",
      label: "JavaScript SDK",
      collapsed: false,
      link: {
        type: "doc",
        id: "build/javascript/index",
      },
      items: [
        "build/javascript/reliable-channels",
        "build/javascript/light-send-receive",
        "build/javascript/store-retrieve-messages",
        "build/javascript/message-encryption",
        "build/javascript/use-waku-react",
        "build/javascript/use-waku-create-app",
        "build/javascript/local-dev-env",
        "build/javascript/configure-discovery",
        "build/javascript/run-waku-nodejs",
        "build/javascript/debug-waku-dapp",
        "build/javascript/manage-filter",
        "build/javascript/faq",
        {
          type: "html",
          value:
            '<a href="https://examples.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">@waku/sdk Examples<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
        },
        {
          type: "html",
          value:
            '<a href="https://js.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
        },
      ],
    },
  ],
  runNode: [
    {
      type: "link",
      label: "Home",
      href: "/",
    },
    {
      type: "category",
      label: "Run a Waku Node",
      collapsed: false,
      link: {
        type: "doc",
        id: "run-node/index",
      },
      items: [
        "run-node/run-docker-compose",
        "run-node/run-docker",
        "run-node/build-source",
        "run-node/configure-discovery",
        "run-node/find-node-address",
        "run-node/config-methods",
        "run-node/config-options",
        "run-node/configure-nwaku",
        "run-node/faq",
        "run-node/upgrade-instructions",
        {
          type: "html",
          value:
            '<a href="https://waku-org.github.io/waku-rest-api/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">REST API Reference<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
        },
      ],
    },
  ],
  learn: [
    {
      type: "link",
      label: "Home",
      href: "/",
    },
    "learn/index",
    {
      type: "category",
      label: "Concepts",
      collapsed: false,
      items: [
        "learn/concepts/protocols",
        "learn/concepts/content-topics",
        "learn/concepts/network-domains",
        "learn/concepts/transports",
        {
          type: "category",
          label: "Peer Discovery",
          link: {
            type: "doc",
            id: "learn/concepts/peer-discovery",
          },
          items: [
            "learn/concepts/static-peers",
            "learn/concepts/dns-discovery",
            "learn/concepts/discv5",
            "learn/concepts/peer-exchange",
          ],
        },
      ],
    },
    "learn/security-features",
    {
      type: "category",
      label: "Research",
      link: {
        type: "doc",
        id: "learn/research/index",
      },
      items: [
        {
          type: "category",
          label: "Benchmarks",
          collapsed: false,
          items: [
            {
              type: "autogenerated",
              dirName: "learn/research/benchmarks",
            },
          ],
        },
        {
          type: "category",
          label: "Research and Studies",
          collapsed: false,
          items: [
            {
              type: "autogenerated",
              dirName: "learn/research/research-and-studies",
            },
          ],
        },
      ],
    },
    "learn/waku-vs-libp2p",
    "learn/glossary",
    "learn/faq",
  ],
};

module.exports = sidebars;