From 61e6d92633cfe5c24e7d0b0cc7b6845fcdeac685 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Mon, 22 May 2023 06:19:27 +0100 Subject: [PATCH] add community page --- docs/community.md | 21 +++++++++++++++++++ docs/overview/concepts/network-domains.md | 4 ++-- .../{node-discovery.md => peer-discovery.md} | 6 +++--- docs/overview/concepts/protocols.md | 2 +- docusaurus.config.js | 2 +- sidebars.js | 5 ++++- 6 files changed, 32 insertions(+), 8 deletions(-) create mode 100644 docs/community.md rename docs/overview/concepts/{node-discovery.md => peer-discovery.md} (94%) diff --git a/docs/community.md b/docs/community.md new file mode 100644 index 0000000..9c6394e --- /dev/null +++ b/docs/community.md @@ -0,0 +1,21 @@ +--- +title: Join Our Community +--- + +Welcome to the Waku Community! Whether you're interested in building with Waku, contributing to the network, expanding your knowledge, or staying up-to-date with our progress, we have something for everyone. + +## [Discourse](https://forum.vac.dev/) + +Have you got questions, or are you eager to discuss Waku? Head to the [Vac Discourse forum](https://forum.vac.dev/) and join the conversation! + +## [Discord](https://discord.gg/Nrac59MfSX) + +Connect with like-minded individuals in the Waku ecosystem! Introduce yourself, join developer conversations, or seek assistance. Join the [Vac Discord](https://discord.gg/Nrac59MfSX) today! + +## [Twitter](https://twitter.com/waku_org) + +Stay informed and updated with the latest news and insights from Waku. [Follow us on Twitter](https://twitter.com/waku_org) now for all the exciting updates! + +## [Telegram](https://t.me/waku_org) + +Join the [Waku Telegram group](https://t.me/waku_org) now and become part of the thriving community! Stay informed, share ideas, and connect with fellow enthusiasts. \ No newline at end of file diff --git a/docs/overview/concepts/network-domains.md b/docs/overview/concepts/network-domains.md index 9f5a0cb..dfd0e26 100644 --- a/docs/overview/concepts/network-domains.md +++ b/docs/overview/concepts/network-domains.md @@ -1,12 +1,12 @@ --- -title: Network Interaction Domains +title: Network Domains --- Waku is a unified and cohesive entity that offers a rich ecosystem with three distinct network interaction domains. These domains serve specialized purposes and contribute to the robust functionality of Waku, forming its foundation. ## Discovery Domain -Node discovery in Waku facilitates locating other nodes within the network. As a modular protocol, Waku incorporates various discovery mechanisms, such as [`Discv5`](/overview/concepts/node-discovery#discv5) and [`Peer Exchange`](/overview/concepts/node-discovery#peer-exchange). These mechanisms allow developers to choose the most suitable option(s) for their specific use cases and user environments, including mobile phones, desktop browsers, servers, and more. +Peer discovery in Waku facilitates locating other nodes within the network. As a modular protocol, Waku incorporates various discovery mechanisms, such as [`Discv5`](/overview/concepts/peer-discovery#discv5) and [`Peer Exchange`](/overview/concepts/peer-discovery#peer-exchange). These mechanisms allow developers to choose the most suitable option(s) for their specific use cases and user environments, including mobile phones, desktop browsers, servers, and more. ## Gossip Domain diff --git a/docs/overview/concepts/node-discovery.md b/docs/overview/concepts/peer-discovery.md similarity index 94% rename from docs/overview/concepts/node-discovery.md rename to docs/overview/concepts/peer-discovery.md index 86f951f..cb65337 100644 --- a/docs/overview/concepts/node-discovery.md +++ b/docs/overview/concepts/peer-discovery.md @@ -1,10 +1,10 @@ --- -title: Node Discovery Mechanisms +title: Peer Discovery --- -When initializing a Waku node, it must connect with other nodes to enable message sending, receiving, and retrieval. To achieve this, a discovery mechanism is employed to locate and connect with other nodes. This process is known as bootstrapping. +When initializing a Waku node, it must connect with other peers to enable message sending, receiving, and retrieval. To achieve this, a discovery mechanism is employed to locate and connect with other peers. This process is known as bootstrapping. -After establishing a connection, the node must actively seek out additional peers to have: +Once a connection is established, the node must actively seek out additional peers to have: - Sufficient peers in the [Relay](/overview/concepts/protocols#relay) mesh: The goal is to have at least 6 peers in the mesh. This ensures a robust network where messages can be efficiently relayed. - Reserve peers for backup: It is essential to have a surplus of peers available as reserves. These reserves are backups when the current peers become overloaded or experience unexpected disconnections. diff --git a/docs/overview/concepts/protocols.md b/docs/overview/concepts/protocols.md index 35580b5..3614d58 100644 --- a/docs/overview/concepts/protocols.md +++ b/docs/overview/concepts/protocols.md @@ -10,7 +10,7 @@ The `Relay` protocol employs a Pub/Sub architecture to facilitate message routin ## [Filter](https://rfc.vac.dev/spec/12/) -The `Filter` protocol allows nodes to selectively subscribe to specific messages transmitted by other nodes. It is designed to be a lightweight alternative to the `Relay` protocol, particularly tailored for devices with limited bandwidth. +The `Filter` protocol allows light nodes to selectively subscribe to specific messages transmitted by other nodes. It is designed to be a lightweight alternative to the `Relay` protocol, particularly tailored for devices with limited bandwidth. ## [Store](https://rfc.vac.dev/spec/13/) diff --git a/docusaurus.config.js b/docusaurus.config.js index 90a53c8..a8e550c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -93,7 +93,7 @@ const config = { footer: { links: [ { - title: "Waku Clients", + title: "Clients", items: [ { to: "/overview/clients", diff --git a/sidebars.js b/sidebars.js index 76af7ce..88dbff1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -16,7 +16,7 @@ const sidebars = { items: [ "overview/concepts/protocols", "overview/concepts/network-domains", - "overview/concepts/node-discovery", + "overview/concepts/peer-discovery", "overview/concepts/content-topics", "overview/concepts/transports" ] @@ -35,6 +35,9 @@ const sidebars = { ], js: [ "clients/js-waku/index" + ], + community: [ + "community" ] };