From 397be651dc3909d61ddc84c39fa4622780dd33c2 Mon Sep 17 00:00:00 2001 From: Danish Arora <35004822+danisharora099@users.noreply.github.com> Date: Fri, 23 Dec 2022 16:59:16 +0530 Subject: [PATCH] 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 --- docs/Concepts/{6.md => content-topics.md} | 0 .../Concepts/{1.md => different-protocols.md} | 0 .../{4.md => discovery-and-bootstrap.md} | 1 + .../Concepts/{2.md => protocols-explained.md} | 2 +- ...{3.md => protocols-overview-by-example.md} | 0 .../{8.md => research-in-progress.md} | 0 docs/Concepts/{7.md => security-features.md} | 5 ++- docs/Concepts/{5.md => transports-in-waku.md} | 0 docs/Concepts/{9.md => waku-vs-libp2p.md} | 0 docs/{2.md => history.md} | 2 +- docs/{7.md => how-does-it-work.md} | 0 docs/{6.md => implementations.md} | 0 docs/{1.md => introduction.md} | 0 docs/{3.md => motivation-and-goals.md} | 0 docs/{5.md => who-is-using-waku.md} | 0 docs/{4.md => why-waku.md} | 0 docusaurus.config.js | 2 +- sidebars.js | 44 ++++++++++--------- 18 files changed, 31 insertions(+), 25 deletions(-) rename docs/Concepts/{6.md => content-topics.md} (100%) rename docs/Concepts/{1.md => different-protocols.md} (100%) rename docs/Concepts/{4.md => discovery-and-bootstrap.md} (99%) rename docs/Concepts/{2.md => protocols-explained.md} (97%) rename docs/Concepts/{3.md => protocols-overview-by-example.md} (100%) rename docs/Concepts/{8.md => research-in-progress.md} (100%) rename docs/Concepts/{7.md => security-features.md} (96%) rename docs/Concepts/{5.md => transports-in-waku.md} (100%) rename docs/Concepts/{9.md => waku-vs-libp2p.md} (100%) rename docs/{2.md => history.md} (92%) rename docs/{7.md => how-does-it-work.md} (100%) rename docs/{6.md => implementations.md} (100%) rename docs/{1.md => introduction.md} (100%) rename docs/{3.md => motivation-and-goals.md} (100%) rename docs/{5.md => who-is-using-waku.md} (100%) rename docs/{4.md => why-waku.md} (100%) diff --git a/docs/Concepts/6.md b/docs/Concepts/content-topics.md similarity index 100% rename from docs/Concepts/6.md rename to docs/Concepts/content-topics.md diff --git a/docs/Concepts/1.md b/docs/Concepts/different-protocols.md similarity index 100% rename from docs/Concepts/1.md rename to docs/Concepts/different-protocols.md diff --git a/docs/Concepts/4.md b/docs/Concepts/discovery-and-bootstrap.md similarity index 99% rename from docs/Concepts/4.md rename to docs/Concepts/discovery-and-bootstrap.md index 3b1e607..8f898cd 100644 --- a/docs/Concepts/4.md +++ b/docs/Concepts/discovery-and-bootstrap.md @@ -21,6 +21,7 @@ An application using Waku can hardcode the addresses of bootstrap nodes directly You can choose to use Status' deployed nodes, or run your own. :::info Developers have the choice to run their own [nwaku](https://github.com/status-im/nim-waku/) nodes. Read [Nwaku Service Node](https://github.com/status-im/nwaku/tree/master/docs/operators) to learn how to run your own node. +:::: **Pros:** diff --git a/docs/Concepts/2.md b/docs/Concepts/protocols-explained.md similarity index 97% rename from docs/Concepts/2.md rename to docs/Concepts/protocols-explained.md index 84a5e56..8f6db3b 100644 --- a/docs/Concepts/2.md +++ b/docs/Concepts/protocols-explained.md @@ -66,4 +66,4 @@ For example: There are also more experimental libp2p protocols such as [`WAKU-RLN-RELAY`](https://rfc.vac.dev/spec/17/) -You can find more information on this [here](./6.md). +You can find more information on this [here](./research-in-progress.md). diff --git a/docs/Concepts/3.md b/docs/Concepts/protocols-overview-by-example.md similarity index 100% rename from docs/Concepts/3.md rename to docs/Concepts/protocols-overview-by-example.md diff --git a/docs/Concepts/8.md b/docs/Concepts/research-in-progress.md similarity index 100% rename from docs/Concepts/8.md rename to docs/Concepts/research-in-progress.md diff --git a/docs/Concepts/7.md b/docs/Concepts/security-features.md similarity index 96% rename from docs/Concepts/7.md rename to docs/Concepts/security-features.md index 1538335..3b2c7cc 100644 --- a/docs/Concepts/7.md +++ b/docs/Concepts/security-features.md @@ -41,7 +41,7 @@ This property indicates that no adversary can flood the system (i.e., publishing Spam protection is partly provided in `WAKU2-RELAY` through the [scoring mechanism](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#spam-protection-measures) provided for by GossipSub v1.1. At a high level, peers utilize a scoring function to locally score the behavior of their connections and remove peers with a low score. -There's also further research being done in this domain, including the designing of (RLN (Rate Limiting Nullifiers))[./7.md] +There's also further research being done in this domain, including the designing of [RLN (Rate Limiting Nullifiers)](./research-in-progress.md) https://github.com/vacp2p/research/issues/148 @@ -50,7 +50,8 @@ https://github.com/vacp2p/research/issues/148 Confidentiality can be addressed through data encryption whereas integrity and authenticity are achievable through digital signatures. These features are provided for in [WAKU-MESSAGE (version 1)](https://rfc.vac.dev/spec/14#version-1) and [WAKU-NOISE](https://rfc.vac.dev/spec/35/) through payload encryption as well as encrypted signatures. -> `WAKU-NOISE` enables secure channel negotiation over Waku. +:::info `WAKU-NOISE` enables secure channel negotiation over Waku. +::: ## Security Considerations diff --git a/docs/Concepts/5.md b/docs/Concepts/transports-in-waku.md similarity index 100% rename from docs/Concepts/5.md rename to docs/Concepts/transports-in-waku.md diff --git a/docs/Concepts/9.md b/docs/Concepts/waku-vs-libp2p.md similarity index 100% rename from docs/Concepts/9.md rename to docs/Concepts/waku-vs-libp2p.md diff --git a/docs/2.md b/docs/history.md similarity index 92% rename from docs/2.md rename to docs/history.md index fc75d5e..4e72fdd 100644 --- a/docs/2.md +++ b/docs/history.md @@ -3,7 +3,7 @@ title: History --- Waku v1 was a fork of Whisper with some added tweaks for efficiency. -Waku v2 is a completely redesigned suite of protocols designed to address the goals set out [previously](./1.md). +Waku v2 is a completely redesigned suite of protocols designed to address the goals set out [previously](./introduction.md). ### 2013 diff --git a/docs/7.md b/docs/how-does-it-work.md similarity index 100% rename from docs/7.md rename to docs/how-does-it-work.md diff --git a/docs/6.md b/docs/implementations.md similarity index 100% rename from docs/6.md rename to docs/implementations.md diff --git a/docs/1.md b/docs/introduction.md similarity index 100% rename from docs/1.md rename to docs/introduction.md diff --git a/docs/3.md b/docs/motivation-and-goals.md similarity index 100% rename from docs/3.md rename to docs/motivation-and-goals.md diff --git a/docs/5.md b/docs/who-is-using-waku.md similarity index 100% rename from docs/5.md rename to docs/who-is-using-waku.md diff --git a/docs/4.md b/docs/why-waku.md similarity index 100% rename from docs/4.md rename to docs/why-waku.md diff --git a/docusaurus.config.js b/docusaurus.config.js index 7c2c0ac..37c015d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -61,7 +61,7 @@ const config = { items: [ { type: "doc", - docId: "Concepts/1", + docId: "Concepts/different-protocols", position: "left", label: "Concepts", }, diff --git a/sidebars.js b/sidebars.js index 28cb924..1c03058 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,29 +1,33 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ + const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{ type: "autogenerated", dirName: "." }] - // But you can create a sidebar manually - /* - tutorialSidebar: [ + docs: [ + "introduction", + "history", + "motivation-and-goals", + "why-waku", + "who-is-using-waku", + "implementations", + "how-does-it-work", { - type: 'category', - label: 'Tutorial', - items: ['hello'], + type: "category", + label: "Concepts", + collapsed: false, + collapsible: true, + items: [ + "Concepts/different-protocols", + "Concepts/protocols-explained", + "Concepts/protocols-overview-by-example", + "Concepts/discovery-and-bootstrap", + "Concepts/transports-in-waku", + "Concepts/content-topics", + "Concepts/security-features", + "Concepts/research-in-progress", + "Concepts/waku-vs-libp2p", + ], }, ], - */ }; module.exports = sidebars;