From 6544c9a8d9f77627b2bb75df3ef19bf38363cee0 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Sat, 20 May 2023 05:23:47 +0100 Subject: [PATCH] navbar reorg --- .../js-waku/{introduction.mdx => index.md} | 1 + docs/overview/clients.md | 2 +- docs/overview/{what-is-waku.md => index.md} | 0 docs/overview/reference/waku-vs-libp2p.md | 4 +- docs/overview/who-is-using-waku.md | 12 +++--- docusaurus.config.js | 39 +++++++++++++++---- sidebars.js | 6 +-- 7 files changed, 43 insertions(+), 21 deletions(-) rename docs/clients/js-waku/{introduction.mdx => index.md} (98%) rename docs/overview/{what-is-waku.md => index.md} (100%) diff --git a/docs/clients/js-waku/introduction.mdx b/docs/clients/js-waku/index.md similarity index 98% rename from docs/clients/js-waku/introduction.mdx rename to docs/clients/js-waku/index.md index 8d7ea6e..f4b182e 100644 --- a/docs/clients/js-waku/introduction.mdx +++ b/docs/clients/js-waku/index.md @@ -1,5 +1,6 @@ --- title: Introduction +slug: /clients/js-waku --- # JS-Waku Documentation diff --git a/docs/overview/clients.md b/docs/overview/clients.md index ccae4ac..d12d4c8 100644 --- a/docs/overview/clients.md +++ b/docs/overview/clients.md @@ -8,7 +8,7 @@ Waku has been implemented in multiple programming languages to address various u The Nim implementation of the Waku protocol is the reference implementation recommended for deploying a node in the cloud or at home. -### [js-waku](https://github.com/waku-org/js-waku/) +### [js-waku](/clients/js-waku) The JavaScript/TypeScript implementation of the Waku protocol designed for use in browser environments. diff --git a/docs/overview/what-is-waku.md b/docs/overview/index.md similarity index 100% rename from docs/overview/what-is-waku.md rename to docs/overview/index.md diff --git a/docs/overview/reference/waku-vs-libp2p.md b/docs/overview/reference/waku-vs-libp2p.md index 7295a82..dd9734e 100644 --- a/docs/overview/reference/waku-vs-libp2p.md +++ b/docs/overview/reference/waku-vs-libp2p.md @@ -6,9 +6,7 @@ Since Waku is built on top of libp2p, they share a lot of concepts and terminolo ## Waku as a Service Network -Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. - -However, you are encouraged to [run your node](https://github.com/waku-org/nwaku/tree/master/docs/operators) to support and decentralize the network. +Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. However, you are encouraged to [run your node](https://github.com/waku-org/nwaku/tree/master/docs/operators) to support and decentralize the network. ## Waku as a Keyturn Solution diff --git a/docs/overview/who-is-using-waku.md b/docs/overview/who-is-using-waku.md index 658bda9..3ccbba8 100644 --- a/docs/overview/who-is-using-waku.md +++ b/docs/overview/who-is-using-waku.md @@ -2,14 +2,14 @@ title: Who is Using Waku? --- -### Status +### [Status](https://status.im/) -[Status](https://status.im/) is a secure messaging app, crypto wallet, and Web3 browser built with state-of-the-art technology. +Status is a secure messaging app, crypto wallet, and Web3 browser built with state-of-the-art technology. -### XMTP +### [XMTP](https://xmtp.org/) -[XMTP](https://xmtp.org/) uses Waku to enable secure Web3 messaging in their open protocol and network. +XMTP uses Waku to enable secure Web3 messaging in their open protocol and network. -### RAILGUN +### [RAILGUN](https://railgun.org/) -[RAILGUN](https://railgun.org/) uses Waku to offer private ETH gas payments to users, ensuring anonymity and privacy for their stablecoin and token transactions. +RAILGUN uses Waku to offer private ETH gas payments to users, ensuring anonymity and privacy for their stablecoin and token transactions. diff --git a/docusaurus.config.js b/docusaurus.config.js index 1e1b263..f18f684 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -20,7 +20,6 @@ const config = { presets: [ [ "@acid-info/logos-docusaurus-preset", - /** @type {import("@acid-info/logos-docusaurus-preset").PluginOptions} */ ({ businessUnit: "Waku", customSiteConfig: true, @@ -53,20 +52,34 @@ const config = { items: [ { type: "docSidebar", - position: "left", + position: "right", sidebarId: "main", label: "Getting Started" }, { type: "dropdown", label: "Waku Clients", - position: "left", + position: "right", items: [ { - label: "JS-Waku", + label: "Overview", + to: "/overview/clients" + }, + { + label: "JS Waku", to: "/clients/js-waku" } ] + }, + { + to: "/powered-by-waku", + label: "Powered by Waku", + position: "right" + }, + { + to: "/community", + label: "Community", + position: "right" } ] }, @@ -77,10 +90,20 @@ const config = { isCloseable: true }, footer: { - links: [{ - title: "Waku Clients", - items: [] - }, + links: [ + { + title: "Waku Clients", + items: [ + { + to: "/overview/clients", + label: "Overview" + }, + { + to: "/clients/js-waku", + label: "JS Waku" + } + ] + }, { title: "Community", items: [{ diff --git a/sidebars.js b/sidebars.js index f64cb3c..27b7230 100644 --- a/sidebars.js +++ b/sidebars.js @@ -3,12 +3,12 @@ /** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ const sidebars = { main: [ - "overview/what-is-waku", + "overview/index", "overview/history", "overview/why-waku", "overview/use-cases", - "overview/who-is-using-waku", "overview/clients", + "overview/who-is-using-waku", { type: "category", label: "Waku Concepts", @@ -35,7 +35,7 @@ const sidebars = { } ], js: [ - "clients/js-waku/introduction" + "clients/js-waku/index" ] };