From c0622617893e792c71839c0b94669887ddbb30c6 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Sat, 20 May 2023 00:35:51 +0100 Subject: [PATCH] update docs settings --- docs/overview/reference/security-features.md | 2 +- docs/overview/reference/waku-vs-libp2p.md | 2 +- docs/overview/what-is-waku.md | 4 +- docusaurus.config.js | 278 +++++++++---------- sidebars.js | 79 +++--- 5 files changed, 180 insertions(+), 185 deletions(-) diff --git a/docs/overview/reference/security-features.md b/docs/overview/reference/security-features.md index ae7d623..913c00f 100644 --- a/docs/overview/reference/security-features.md +++ b/docs/overview/reference/security-features.md @@ -21,7 +21,7 @@ Anonymity means an adversary cannot connect an actor to their actions or data. T The spam protection feature in `Waku Relay` ensures that no adversary can flood the system with many messages, intentionally or not, regardless of the content's validity or usefulness. This protection is achieved through the [scoring mechanism](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#spam-protection-measures) of `GossipSub v1.1`. Peers assign scores to their connections based on their behavior and remove peers with low scores. -Ongoing research is being conducted, including developing [Rate Limiting Nullifiers (RLN)](overview/concepts/protocols#waku-rln-relay), which can be explored further at: . +Ongoing research is being conducted, including developing [Rate Limiting Nullifiers (RLN)](/overview/concepts/protocols#waku-rln-relay), which can be explored further at: . ## [Data Confidentiality, Integrity, and Authenticity](https://rfc.vac.dev/spec/10/#data-confidentiality-integrity-and-authenticity) diff --git a/docs/overview/reference/waku-vs-libp2p.md b/docs/overview/reference/waku-vs-libp2p.md index e993f5f..7295a82 100644 --- a/docs/overview/reference/waku-vs-libp2p.md +++ b/docs/overview/reference/waku-vs-libp2p.md @@ -1,5 +1,5 @@ --- -title: Waku vs. libp2p - What's the Difference? +title: Comparing Waku and libp2p --- Since Waku is built on top of libp2p, they share a lot of concepts and terminologies between them. However, there are key differences between them that are worth noting. diff --git a/docs/overview/what-is-waku.md b/docs/overview/what-is-waku.md index b022b47..4b4f37a 100644 --- a/docs/overview/what-is-waku.md +++ b/docs/overview/what-is-waku.md @@ -33,7 +33,7 @@ Waku can cater to applications that require privacy guarantees, such as: - Pseudonymity and not being tied to any Personally Identifiable Information (PII). - Metadata protection in transit. -- Various forms of [unlinkability](overview/reference/security-features#anonymityunlinkability). +- Various forms of [unlinkability](/overview/reference/security-features#anonymityunlinkability). ### Modular Design @@ -47,7 +47,7 @@ These options are part of the [Anonymity Trilemma](https://eprint.iacr.org/2017/ ## How Does Waku Work? -The [Waku Relay](overview/concepts/protocols#waku-relay) protocol is the foundation of the Waku network, which employs a Pub/Sub architecture built on the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). Additionally, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to: +The [Waku Relay](/overview/concepts/protocols#waku-relay) protocol is the foundation of the Waku network, which employs a Pub/Sub architecture built on the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). Additionally, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to: 1. Facilitating the retrieval of historical messages for primarily offline devices. 2. Providing solutions for encrypted communication, such as symmetric encryption, ECIES/asymmetric encryption, and noise handshake-based key turns. diff --git a/docusaurus.config.js b/docusaurus.config.js index 5df8e75..cdf104a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -2,148 +2,144 @@ // Note: type annotations allow type checking and IDEs autocompletion require("dotenv").config(); -/** @type {import('@docusaurus/types').Config} */ +/** @type {import("@docusaurus/types").Config} */ const config = { - title: "Waku Documentation Portal", - url: "https://waku.guide/", - baseUrl: "/", - onBrokenLinks: "throw", - onBrokenMarkdownLinks: "warn", + title: "Waku Documentation Portal", + url: "https://waku.guide/", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", - // Even if you don't use internalization, you can use this field to set useful - // metadata like html lang. For example, if your site is Chinese, you may want - // to replace "en" with "zh-Hans". - i18n: { - defaultLocale: "en", - locales: ["en"], - }, - - presets: [ - [ - "@acid-info/logos-docusaurus-preset", - /** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */ - ({ - businessUnit: "Waku", - customSiteConfig: true, - docs: { - routeBasePath: "/", - sidebarPath: require.resolve("./sidebars.js"), - editUrl: "https://github.com/waku-org/waku.guide/tree/develop/", - }, - theme: { - name: "docusaurus-default", - options: { - customCss: [require.resolve("./src/css/custom.scss")], - }, - }, - }), - ], - ], - staticDirectories: ["static"], - themeConfig: - /** @type {import('@acid-info/logos-docusaurus-preset').ThemeConfig} */ - ({ - navbar: { - title: "Waku", - logo: { - srcDark: "logo_white.svg", - }, - items: [ - { - type: 'docSidebar', - position: 'left', - sidebarId: 'main', - label: 'Getting Started', - }, - ], - }, - announcementBar: { - content: - "While Waku is still in development and needs to prepare for extensive adoption, it is already being used by Status, XMTP and Railgun. Join our Discord Community to stay updated on our progress.", - backgroundColor: "#EBEDF0", - textColor: "#1B1B1D", - isCloseable: true, - }, - footer: { - links: [ - { - title: "Legal", - items: [ - { - href: "https://waku.org/terms-of-use", - label: "Terms of Use", - }, - { - href: "https://waku.org/privacy-policy", - label: "Privacy Policy", - }, - ], - }, - { - title: "Community", - items: [ - { - href: "https://forum.vac.dev/", - label: "Discourse", - }, - { - href: "https://discord.gg/Nrac59MfSX", - label: "Discord", - }, - { - href: "https://twitter.com/waku_org", - label: "Twitter", - }, - { - href: "https://t.me/waku_org", - label: "Telegram", - }, - ], - }, - { - title: "Resources", - items: [ - { - href: "https://github.com/waku-org", - label: "GitHub", - }, - { - href: "https://vac.dev/research", - label: "Blog", - }, - { - href: "https://vac.dev/", - label: "Vac", - }, - { - href: "https://rfc.vac.dev/", - label: "Vac RFCs", - }, - ], - }, - ], - }, - colorMode: { - defaultMode: "light", - disableSwitch: false, - respectPrefersColorScheme: false, - }, - }), - - plugins: [ - [ - "@easyops-cn/docusaurus-search-local", - { - hashed: true, - indexDocs: true, - indexPages: true, - }, - ], - ], - themes: ["@docusaurus/theme-mermaid"], - markdown: { - mermaid: true, - }, + // Even if you don't use internalization, you can use this field to set useful + // metadata like html lang. For example, if your site is Chinese, you may want + // to replace "en" with "zh-Hans". + i18n: { + defaultLocale: "en", + locales: ["en"] + }, + presets: [ + [ + "@acid-info/logos-docusaurus-preset", + /** @type {import("@acid-info/logos-docusaurus-preset").PluginOptions} */ + ({ + businessUnit: "Waku", + customSiteConfig: true, + docs: { + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.js"), + editUrl: "https://github.com/waku-org/waku.guide/tree/develop/" + }, + theme: { + name: "docusaurus-default", + options: { + customCss: [require.resolve("./src/css/custom.scss")] + } + } + }) + ] + ], + staticDirectories: ["static"], + themeConfig: ({ + docs: { + sidebar: { + hideable: false + } + }, + navbar: { + title: "Waku", + logo: { + srcDark: "logo_white.svg" + }, + items: [ + { + type: "docSidebar", + position: "left", + sidebarId: "main", + label: "Getting Started" + } + ] + }, + announcementBar: { + content: "While Waku is still in development and needs to prepare for extensive adoption, it is already being used by Status, XMTP, and Railgun. Join our Discord Community to stay updated on our progress.", + backgroundColor: "#EBEDF0", + textColor: "#1B1B1D", + isCloseable: true + }, + footer: { + links: [{ + title: "Waku Clients", + items: [] + }, + { + title: "Community", + items: [{ + href: "https://forum.vac.dev/", + label: "Discourse" + }, + { + href: "https://discord.gg/Nrac59MfSX", + label: "Discord" + }, + { + href: "https://twitter.com/waku_org", + label: "Twitter" + }, + { + href: "https://t.me/waku_org", + label: "Telegram" + } + ] + }, + { + title: "Resources", + items: [{ + href: "https://github.com/waku-org", + label: "GitHub" + }, + { + href: "https://vac.dev/research", + label: "Blog" + }, + { + href: "https://rfc.vac.dev/", + label: "Vac RFCs" + } + ] + }, + { + title: "Legal", + items: [{ + href: "https://waku.org/terms-of-use", + label: "Terms of Use" + }, + { + href: "https://waku.org/privacy-policy", + label: "Privacy Policy" + } + ] + } + ] + }, + colorMode: { + defaultMode: "light", + disableSwitch: false, + respectPrefersColorScheme: false + } + }), + plugins: [ + [ + "@easyops-cn/docusaurus-search-local", + { + hashed: true, + indexDocs: true, + indexPages: true + } + ] + ], + themes: ["@docusaurus/theme-mermaid"], + markdown: { + mermaid: true + } }; -module.exports = config; +module.exports = config; \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index f5376f0..7be5de2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,45 +1,44 @@ // @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ - +/** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ const sidebars = { - main: [ - "overview/what-is-waku", - "overview/history", - "overview/why-waku", - "overview/use-cases", - "overview/who-is-using-waku", - "overview/implementations", - { - type: "category", - label: "Waku Concepts", - collapsed: false, - collapsible: true, - items: [ - "overview/concepts/protocols", - "overview/concepts/network-domains", - "overview/concepts/node-discovery", - "overview/concepts/content-topics", - "overview/concepts/transports", - ], - }, - { - type: "category", - label: "Reference", - collapsed: true, - collapsible: true, - items: [ - "overview/reference/security-features", - "overview/reference/research-in-progress", - "overview/reference/waku-vs-libp2p", - ], - }, - ], - browser: [ - "browser/introduction", - "browser/quick-start", - "browser/build-chat-app", - ] + main: [ + "overview/what-is-waku", + "overview/history", + "overview/why-waku", + "overview/use-cases", + "overview/who-is-using-waku", + "overview/implementations", + { + type: "category", + label: "Waku Concepts", + collapsed: false, + collapsible: true, + items: [ + "overview/concepts/protocols", + "overview/concepts/network-domains", + "overview/concepts/node-discovery", + "overview/concepts/content-topics", + "overview/concepts/transports" + ] + }, + { + type: "category", + label: "Reference", + collapsed: false, + collapsible: true, + items: [ + "overview/reference/security-features", + "overview/reference/research-in-progress", + "overview/reference/waku-vs-libp2p" + ] + } + ], + js: [ + "browser/introduction", + "browser/quick-start", + "browser/build-chat-app" + ] }; -module.exports = sidebars; +module.exports = sidebars; \ No newline at end of file