docs.waku.org/sidebars.js

136 lines
5.6 KiB
JavaScript
Raw Permalink Normal View History

2022-08-04 11:42:53 +00:00
// @ts-check
feat: use Logos theme & plugin (#33) * Use Logos plugins and theme. * Upgrade dependencies. * feat: improvements on docs (#24) * add: security features * add: protocols overview by example * add: different protocols * add: spell check on CI * rm: yarn.lock to avoid inconsistencies * Update docs/Concepts/1.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/2.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/2.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/7.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/7.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * convert mscgen sequence to mermaid * partially adress review comments * address: comments * fix: ci * chore: address minor typos/changes in docs * add: pros/cons for discv5 and peer-exchange * fix: minor typo * chore: address refactoring Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * chore: refactor ordering/naming of markdown files (#29) * chore: rename md files and use config ordering it is unfeasible to track the changes in files labelled as '1.md', '2.md', etc and way easier when the files are named after their contents. * fix: hint box render * fix: markdown links * finish merge * push yarn.lock Co-authored-by: Hossein Mehrabi <ohyeaross@gmail.com> Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>
2023-01-23 09:37:39 +00:00
2023-05-19 23:35:51 +00:00
/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
2022-08-04 11:42:53 +00:00
const sidebars = {
2024-04-22 16:19:26 +00:00
guides: [
"guides/getting-started",
{
type: "category",
label: "Run a Nwaku Node",
2024-05-16 17:22:15 +00:00
collapsed: true,
2024-04-22 16:19:26 +00:00
link: {
type: "doc",
id: "guides/nwaku/run-node",
},
items: [
"guides/nwaku/run-docker-compose",
"guides/nwaku/run-docker",
"guides/nwaku/build-source",
"guides/nwaku/configure-discovery",
2024-05-16 17:22:15 +00:00
"guides/nwaku/find-node-address",
2024-04-22 16:19:26 +00:00
"guides/nwaku/config-methods",
"guides/nwaku/config-options",
"guides/nwaku/configure-nwaku",
"guides/nwaku/faq",
{
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>',
},
],
},
{
type: "category",
label: "JavaScript Waku SDK",
2024-05-16 17:22:15 +00:00
collapsed: true,
2024-04-22 16:19:26 +00:00
link: {
type: "doc",
id: "guides/js-waku/index",
},
items: [
"guides/js-waku/light-send-receive",
"guides/js-waku/store-retrieve-messages",
"guides/js-waku/message-encryption",
"guides/js-waku/use-waku-react",
"guides/js-waku/use-waku-create-app",
"guides/js-waku/configure-discovery",
"guides/js-waku/run-waku-nodejs",
"guides/js-waku/debug-waku-dapp",
"guides/js-waku/manage-filter",
"guides/js-waku/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>',
},
],
},
2024-05-16 17:22:15 +00:00
{
type: "link",
label: "Learn About Waku",
href: "/learn/waku-network",
},
{
type: "link",
label: "Waku Research",
href: "/research",
},
{
type: "html",
value:
'<a href="https://discord.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Discord<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://github.com/waku-org/awesome-waku/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Awesome Waku<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://ideas.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Waku Idea Board<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://github.com/waku-org/bounties/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Post-Hackathon Bounties<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>',
},
2024-04-22 16:19:26 +00:00
],
learn: [
"learn/waku-network",
{
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",
"learn/research",
"learn/waku-vs-libp2p",
"learn/glossary",
"learn/faq",
],
research: [
{
type: "autogenerated",
dirName: "research", // '.' means the current docs folder
},
],
2022-08-04 11:42:53 +00:00
};
module.exports = sidebars;