/ sidebars.js
sidebars.js
  1  // @ts-check
  2  
  3  /** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
  4  const sidebars = {
  5    build: [
  6      {
  7        type: "link",
  8        label: "Home",
  9        href: "/",
 10      },
 11      {
 12        type: "category",
 13        label: "JavaScript SDK",
 14        collapsed: false,
 15        link: {
 16          type: "doc",
 17          id: "build/javascript/index",
 18        },
 19        items: [
 20          "build/javascript/reliable-channels",
 21          "build/javascript/light-send-receive",
 22          "build/javascript/store-retrieve-messages",
 23          "build/javascript/message-encryption",
 24          "build/javascript/use-waku-react",
 25          "build/javascript/use-waku-create-app",
 26          "build/javascript/local-dev-env",
 27          "build/javascript/configure-discovery",
 28          "build/javascript/run-waku-nodejs",
 29          "build/javascript/debug-waku-dapp",
 30          "build/javascript/manage-filter",
 31          "build/javascript/faq",
 32          {
 33            type: "html",
 34            value:
 35              '<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>',
 36          },
 37          {
 38            type: "html",
 39            value:
 40              '<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>',
 41          },
 42        ],
 43      },
 44    ],
 45    runNode: [
 46      {
 47        type: "link",
 48        label: "Home",
 49        href: "/",
 50      },
 51      {
 52        type: "category",
 53        label: "Run a Waku Node",
 54        collapsed: false,
 55        link: {
 56          type: "doc",
 57          id: "run-node/index",
 58        },
 59        items: [
 60          "run-node/run-docker-compose",
 61          "run-node/run-docker",
 62          "run-node/build-source",
 63          "run-node/configure-discovery",
 64          "run-node/find-node-address",
 65          "run-node/config-methods",
 66          "run-node/config-options",
 67          "run-node/configure-nwaku",
 68          "run-node/faq",
 69          "run-node/upgrade-instructions",
 70          {
 71            type: "html",
 72            value:
 73              '<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>',
 74          },
 75        ],
 76      },
 77    ],
 78    learn: [
 79      {
 80        type: "link",
 81        label: "Home",
 82        href: "/",
 83      },
 84      "learn/index",
 85      {
 86        type: "category",
 87        label: "Concepts",
 88        collapsed: false,
 89        items: [
 90          "learn/concepts/protocols",
 91          "learn/concepts/content-topics",
 92          "learn/concepts/network-domains",
 93          "learn/concepts/transports",
 94          {
 95            type: "category",
 96            label: "Peer Discovery",
 97            link: {
 98              type: "doc",
 99              id: "learn/concepts/peer-discovery",
100            },
101            items: [
102              "learn/concepts/static-peers",
103              "learn/concepts/dns-discovery",
104              "learn/concepts/discv5",
105              "learn/concepts/peer-exchange",
106            ],
107          },
108        ],
109      },
110      "learn/security-features",
111      {
112        type: "category",
113        label: "Research",
114        link: {
115          type: "doc",
116          id: "learn/research/index",
117        },
118        items: [
119          {
120            type: "category",
121            label: "Benchmarks",
122            collapsed: false,
123            items: [
124              {
125                type: "autogenerated",
126                dirName: "learn/research/benchmarks",
127              },
128            ],
129          },
130          {
131            type: "category",
132            label: "Research and Studies",
133            collapsed: false,
134            items: [
135              {
136                type: "autogenerated",
137                dirName: "learn/research/research-and-studies",
138              },
139            ],
140          },
141        ],
142      },
143      "learn/waku-vs-libp2p",
144      "learn/glossary",
145      "learn/faq",
146    ],
147  };
148  
149  module.exports = sidebars;