waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs.waku.org/sidebars.js

118 lines
4.2 KiB
JavaScript
Raw Normal View History

initial structure and testing
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
update docs settings
2023-05-19 23:35:51 +00:00
/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */
initial structure and testing
2022-08-04 11:42:53 +00:00
const sidebars = {
update docs settings
2023-05-19 23:35:51 +00:00
main: [
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
"overview/index",
"overview/history",
"overview/why-waku",
"overview/use-cases",
update docs settings
2023-05-19 23:35:51 +00:00
{
type: "category",
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
label: "Concepts",
update docs settings
2023-05-19 23:35:51 +00:00
items: [
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
"overview/concepts/protocols",
"overview/concepts/content-topics",
"overview/concepts/network-domains",
implement guides feedback
2023-06-18 08:34:09 +00:00
"overview/concepts/transports",
improve navbar hint
2023-06-06 02:47:24 +00:00
{
type: "category",
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
label: "Peer Discovery",
link: {
type: "doc",
id: "overview/concepts/peer-discovery",
},
improve navbar hint
2023-06-06 02:47:24 +00:00
items: [
add peer discovery guide
2023-06-16 08:40:22 +00:00
"overview/concepts/static-peers",
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
"overview/concepts/dns-discovery",
"overview/concepts/discv5",
"overview/concepts/peer-exchange",
improve navbar hint
2023-06-06 02:47:24 +00:00
]
},
update docs settings
2023-05-19 23:35:51 +00:00
]
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
},
update docs settings
2023-05-19 23:35:51 +00:00
{
type: "category",
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
label: "Reference",
heading fixes + remove xmtp
2023-06-27 22:38:21 +00:00
collapsed: false,
update docs settings
2023-05-19 23:35:51 +00:00
items: [
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
"overview/reference/glossary",
"overview/reference/security-features",
"overview/reference/research-in-progress",
"overview/reference/waku-vs-libp2p",
update docs settings
2023-05-19 23:35:51 +00:00
]
chore: docs cleanup (#92)
2023-07-15 23:08:27 +00:00
},
{
type: 'html',
value: '<a href="/guides/nodes-and-sdks" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Nodes and SDKs<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>',
update docs settings
2023-05-19 23:35:51 +00:00
}
],
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
guides: [
"guides/nodes-and-sdks",
add nwaku build source guide
2023-06-14 03:34:58 +00:00
{
type: "category",
label: "Run a Nwaku Node",
link: {
type: "doc",
id: "guides/run-nwaku-node",
},
items: [
add node config methods guide
2023-06-15 13:54:02 +00:00
"guides/nwaku/build-source",
add run docker guide
2023-06-14 12:08:58 +00:00
"guides/nwaku/run-docker",
add nwaku compose guide
2023-06-15 02:09:14 +00:00
"guides/nwaku/run-docker-compose",
add peer discovery guide
2023-06-16 08:40:22 +00:00
"guides/nwaku/configure-discovery",
nwaku config guides (#116) * add config examples guide * add domain name config * add store config * add node key config * add websocket config * update nwaku config options * add REST API config * add light push config * add filter config * add feedback updates
2023-09-15 20:08:15 +00:00
"guides/nwaku/configure-nwaku"
add config options reference
2023-06-15 20:42:35 +00:00
]
},
JS-Waku docs (#82) * add js-waku outline * add js-waku quickstart * add waku-create-app guide * add lightpush filter guide * add complete relay guide * initial feedback + add emitSelf * add store guide outline * add store query options * update code snippets
2023-07-11 17:52:38 +00:00
{
type: "category",
label: "JavaScript Waku SDK",
link: {
type: "doc",
id: "guides/js-waku/index",
},
items: [
"guides/js-waku/light-send-receive",
"guides/js-waku/store-retrieve-messages",
@waku/react docs (#90) * add @waku/react outline * add @waku/react hooks docs * add @waku/react providers docs * add more snippet comments + fix code indents
2023-07-15 21:54:13 +00:00
"guides/js-waku/use-waku-create-app",
add js-waku discovery (#100) * add js-waku discovery * implement feedback * update logos preset
2023-08-03 05:40:57 +00:00
"guides/js-waku/configure-discovery",
add js-waku debug guide (#111) * add debug guide * add ws notes * add NodeJS recommendations
2023-08-16 08:29:32 +00:00
"guides/js-waku/run-waku-nodejs",
"guides/js-waku/debug-waku-dapp",
add manage filter guide (#132)
2023-11-21 13:19:52 +00:00
"guides/js-waku/manage-filter",
JS-Waku docs (#82) * add js-waku outline * add js-waku quickstart * add waku-create-app guide * add lightpush filter guide * add complete relay guide * initial feedback + add emitSelf * add store guide outline * add store query options * update code snippets
2023-07-11 17:52:38 +00:00
{
type: 'html',
add js-waku debug guide (#111) * add debug guide * add ws notes * add NodeJS recommendations
2023-08-16 08:29:32 +00:00
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>',
JS-Waku docs (#82) * add js-waku outline * add js-waku quickstart * add waku-create-app guide * add lightpush filter guide * add complete relay guide * initial feedback + add emitSelf * add store guide outline * add store query options * update code snippets
2023-07-11 17:52:38 +00:00
},
{
type: 'html',
chore: improve js-waku docs (#94) * implement initial feedback * remove relay guides
2023-07-18 18:51:12 +00:00
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>',
JS-Waku docs (#82) * add js-waku outline * add js-waku quickstart * add waku-create-app guide * add lightpush filter guide * add complete relay guide * initial feedback + add emitSelf * add store guide outline * add store query options * update code snippets
2023-07-11 17:52:38 +00:00
},
]
},
add config options reference
2023-06-15 20:42:35 +00:00
{
type: "category",
label: "Reference",
heading fixes + remove xmtp
2023-06-27 22:38:21 +00:00
collapsed: false,
add config options reference
2023-06-15 20:42:35 +00:00
items: [
"guides/reference/node-config-methods",
"guides/reference/node-config-options",
add nwaku build source guide
2023-06-14 03:34:58 +00:00
]
},
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
],
add community page
2023-05-22 05:19:27 +00:00
community: [
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
"community",
"contribute",
"presentations",
chore: improve js-waku docs (#94) * implement initial feedback * remove relay guides
2023-07-18 18:51:12 +00:00
"powered-by-waku",
improve guides with feedback
2023-06-20 11:41:55 +00:00
{
type: 'html',
value: '<a href="https://github.com/waku-org/bounties" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Waku 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>',
},
add bounties link
2023-06-02 18:12:50 +00:00
{
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
type: 'html',
value: '<a href="https://hackenproof.com/status-dot-im/waku" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Bug Bounty Program<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>',
},
update docs settings
2023-05-19 23:35:51 +00:00
]
initial structure and testing
2022-08-04 11:42:53 +00:00
};
peer discovery & sidebar reorg
2023-06-14 00:26:55 +00:00
module.exports = sidebars;