From 52dc1b67ff6c82b45e98e831cea074ccf4fcd857 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Thu, 22 Jun 2023 11:46:26 +0100 Subject: [PATCH 1/2] improve docs with feedback --- docs/guides/nwaku/build-source.md | 2 +- docs/guides/nwaku/configure-discovery.md | 10 +++++++--- docs/guides/nwaku/run-docker.md | 2 +- docs/guides/run-nwaku-node.md | 2 +- docs/overview/concepts/protocols.md | 2 +- docs/overview/why-waku.md | 14 +++++++------- 6 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/guides/nwaku/build-source.md b/docs/guides/nwaku/build-source.md index f3c96ef..e21ec6a 100644 --- a/docs/guides/nwaku/build-source.md +++ b/docs/guides/nwaku/build-source.md @@ -98,7 +98,7 @@ To learn more about running nwaku, please refer to: ## Run Test Suite -Run the tests for both `Waku v1` and `Waku v2`: +Run the tests for Waku: ```bash make test diff --git a/docs/guides/nwaku/configure-discovery.md b/docs/guides/nwaku/configure-discovery.md index 348ca6f..30fda8b 100644 --- a/docs/guides/nwaku/configure-discovery.md +++ b/docs/guides/nwaku/configure-discovery.md @@ -41,14 +41,18 @@ To enable [DNS Discovery](/overview/concepts/dns-discovery) in a `nwaku` node, u --dns-discovery-name-server:[DNS NAME SERVER IP] ``` -For instance, consider a `nwaku` node that enables `DNS Discovery`, connects to a DNS node list, and queries the IPs `1.1.1.1` and `1.0.0.1`: +:::info +If you omit the `dns-discovery-name-server` option, `nwaku` will attempt to use the CloudFlare servers `1.1.1.1` and `1.0.0.1`. +::: + +For instance, consider a `nwaku` node that enables `DNS Discovery`, connects to a DNS node list, and queries the IPs `8.8.8.8` and `8.8.4.4`: ```bash ./build/wakunode2 \ --dns-discovery:true \ --dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@test.waku.nodes.status.im \ - --dns-discovery-name-server:1.1.1.1 \ - --dns-discovery-name-server:1.0.0.1 + --dns-discovery-name-server:8.8.8.8 \ + --dns-discovery-name-server:8.8.4.4 ``` ## Configure Discv5 diff --git a/docs/guides/nwaku/run-docker.md b/docs/guides/nwaku/run-docker.md index 9aad6ed..a0afb87 100644 --- a/docs/guides/nwaku/run-docker.md +++ b/docs/guides/nwaku/run-docker.md @@ -51,12 +51,12 @@ docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku \ --nat:extip:[YOUR PUBLIC IP] # or, if you are behind a nat: --nat=any ``` -:::tip To find your public IP, use: ```bash dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}' ``` +:::tip We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers). ::: \ No newline at end of file diff --git a/docs/guides/run-nwaku-node.md b/docs/guides/run-nwaku-node.md index e7ed322..4542c5e 100644 --- a/docs/guides/run-nwaku-node.md +++ b/docs/guides/run-nwaku-node.md @@ -105,7 +105,7 @@ curl --location --request GET 'http://localhost:8545' \ :::info -The `listenAddresses` field stores the node's listening address(es), while the `enrUri` field stores the discoverable `ENR` URI for peer discovery. +The `listenAddresses` field stores the node's listening addresses, while the `enrUri` field stores the discoverable `ENR` URI for peer discovery. ::: ## Find the Node Addresses diff --git a/docs/overview/concepts/protocols.md b/docs/overview/concepts/protocols.md index e946059..100a534 100644 --- a/docs/overview/concepts/protocols.md +++ b/docs/overview/concepts/protocols.md @@ -38,7 +38,7 @@ While the `Light Push` protocol acknowledges the receipt by the remote peer, it ## [Waku Message](https://rfc.vac.dev/spec/14) -`Waku Message` specifies the message structure used in the Waku Network. It defines the attributes and metadata fields that accompany a message, including the following: +`Waku Message` specifies the structure and format of messages in the Waku Network. It includes the following attributes: - `content_topic` attribute for [content-based filtering](/overview/concepts/content-topics). - `payload` attribute containing the message data payload to be sent. diff --git a/docs/overview/why-waku.md b/docs/overview/why-waku.md index 864afb7..1a2bd54 100644 --- a/docs/overview/why-waku.md +++ b/docs/overview/why-waku.md @@ -2,16 +2,16 @@ title: Why Waku? --- -Communication in the present day is heavily influenced by third-party intervention, ranging from censorship and deplatforming to intermediaries that seek to profit from rent and the misuse of data in the surveillance economy. +Present-day communication is predominantly centralized, enabling significant third-party intervention, with profit motives overshadowing principles and downplaying censorship and privacy concerns. This shift leads to the exploitation and unauthorized use of user data in the surveillance economy, where data ownership is no longer in the hands of individuals. -Waku is intended to empower individuals by returning control of communication to them. It is the go-to standard for Web3 communication, offering a scalable decentralized communication solution. +Waku empowers individuals by restoring control of communication and data to them. Waku stands as the standard for Web3 communication, providing a scalable and decentralized solution. - Waku improves upon Whisper's capabilities by overcoming limitations and addressing functional gaps. -- It provides a public infrastructure for the Ethereum and multi-chain ecosystem, serving as a common good. -- It is not confined to a particular blockchain. -- It is modular, adaptable, and can cater to various use cases. -- It allows developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization. -- It can run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)! +- Provides a public infrastructure for the Ethereum and multi-chain ecosystem, serving as a common good. +- Waku is not confined to a particular blockchain. +- Modular, adaptable, configurable, and can cater to various use cases. +- Enables developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization. +- Designed to run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)! ## Why Waku is Necessary From 8c6d4f075647802e2029f5c2bd4223fbf407185a Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Tue, 27 Jun 2023 23:38:21 +0100 Subject: [PATCH 2/2] heading fixes + remove xmtp --- docs/guides/nwaku/configure-discovery.md | 2 +- docs/guides/nwaku/run-docker.md | 2 +- docs/guides/run-nwaku-node.md | 4 ++-- docs/overview/concepts/content-topics.md | 2 +- docs/overview/index.md | 2 +- docs/overview/reference/glossary.md | 2 +- docs/powered-by-waku.mdx | 9 +-------- sidebars.js | 2 ++ static/img/xmtp-mark-black.svg | 10 ---------- static/img/xmtp-mark-white.svg | 10 ---------- 10 files changed, 10 insertions(+), 35 deletions(-) delete mode 100644 static/img/xmtp-mark-black.svg delete mode 100644 static/img/xmtp-mark-white.svg diff --git a/docs/guides/nwaku/configure-discovery.md b/docs/guides/nwaku/configure-discovery.md index 30fda8b..86717ef 100644 --- a/docs/guides/nwaku/configure-discovery.md +++ b/docs/guides/nwaku/configure-discovery.md @@ -69,7 +69,7 @@ To enable [Discv5](/overview/concepts/discv5) in a `nwaku` node, use the followi --discv5-bootstrap-node:[DISCV5 ENR BOOTSTRAP ENTRY 2] ``` -For instance, consider a `nwaku` node that enables `Discv5` and bootstraps it's routing table using a static `ENR`: +For instance, consider a `nwaku` node that enables `Discv5` and bootstraps its routing table using a static `ENR`: ```bash ./build/wakunode2 \ diff --git a/docs/guides/nwaku/run-docker.md b/docs/guides/nwaku/run-docker.md index a0afb87..b79cd86 100644 --- a/docs/guides/nwaku/run-docker.md +++ b/docs/guides/nwaku/run-docker.md @@ -2,7 +2,7 @@ title: Run Nwaku in a Docker Container --- -This guide provides detailed steps to build and run a `nwaku` node in a Docker container. If you prefer a pre-configured setup that includes a monitoring dashboard, see the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide. +This guide provides detailed steps to build and run a `nwaku` node in a Docker container. If you prefer a pre-configured setup with a monitoring dashboard, see the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide. ## Prerequisites diff --git a/docs/guides/run-nwaku-node.md b/docs/guides/run-nwaku-node.md index 4542c5e..c67add7 100644 --- a/docs/guides/run-nwaku-node.md +++ b/docs/guides/run-nwaku-node.md @@ -6,7 +6,7 @@ Nwaku is a lightweight and robust Nim client for running a Waku node, equipped w This guide provides detailed steps to download, build, configure, and connect a `nwaku` node to the Waku Network. It also includes interacting with the node and finding its addresses. -## Get the Binary +## Get the Node Binary To run a node, you must have the `nwaku` binary. Nwaku provides multiple options for acquiring the node binary: @@ -21,7 +21,7 @@ To run a node, you must have the `nwaku` binary. Nwaku provides multiple options You can build the node binary directly from the [nwaku source code](https://github.com/waku-org/nwaku). To learn more, please refer to the [Build Nwaku from Source](/guides/nwaku/build-source) guide. -#### Run the Binary in Docker +#### Run Nwaku in Docker | | Description | Documentation | | - | - | - | diff --git a/docs/overview/concepts/content-topics.md b/docs/overview/concepts/content-topics.md index cd03201..6c6cd88 100644 --- a/docs/overview/concepts/content-topics.md +++ b/docs/overview/concepts/content-topics.md @@ -4,7 +4,7 @@ title: Content Topics `Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/overview/concepts/protocols#relay) or [Filter](/overview/concepts/protocols#filter)) and retrieving historical messages ([Store](/overview/concepts/protocols#store)) that meet specific filtering criteria. Please refer to the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more. -## Content Topic Format +## Naming Format Here is the recommended format for content topics: diff --git a/docs/overview/index.md b/docs/overview/index.md index 7b5d9ec..a93f63f 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,5 +1,5 @@ --- -title: What is Waku? +title: Introduction to Waku slug: / --- diff --git a/docs/overview/reference/glossary.md b/docs/overview/reference/glossary.md index 89f933d..7122f1d 100644 --- a/docs/overview/reference/glossary.md +++ b/docs/overview/reference/glossary.md @@ -28,7 +28,7 @@ DNS discovery is a [peer discovery](#peer-discovery) mechanism that allows the r ### [ENR](https://rfc.vac.dev/spec/31/) -Ethereum Node Record (ENR) is a specification used to represent and identify [nodes](#node), facilitating [discovery](#peer-discovery) and communication within the network. Besides connection details, `Waku ENR` also includes node configuration information like enabled protocol and shards. +Ethereum Node Record (ENR) is a specification used to represent and identify [nodes](#node), facilitating [discovery](#peer-discovery) and communication within the network. Besides connection details, `ENR` also includes node configuration information like enabled protocol and shards. ### [Filter](/overview/concepts/protocols#filter) diff --git a/docs/powered-by-waku.mdx b/docs/powered-by-waku.mdx index 8bb8679..e109050 100644 --- a/docs/powered-by-waku.mdx +++ b/docs/powered-by-waku.mdx @@ -32,13 +32,6 @@ import { PoweredBy } from "@site/src/components/mdx"; logoSrcDark: "/img/the-graph-mark-white.svg", link: "https://thegraph.com/", }, - { - name: "XMTP", - description: - "Inter-blockchain account messaging protocol XMTP uses Waku to facilitate communication between nodes in its currently permissioned network.", - logoSrc: "/img/xmtp-mark-black.svg", - logoSrcDark: "/img/xmtp-mark-white.svg", - link: "https://xmtp.org", - }, ]} /> +`` \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 44cf9c4..a320f74 100644 --- a/sidebars.js +++ b/sidebars.js @@ -42,6 +42,7 @@ const sidebars = { { type: "category", label: "Reference", + collapsed: false, items: [ "overview/reference/glossary", "overview/reference/security-features", @@ -69,6 +70,7 @@ const sidebars = { { type: "category", label: "Reference", + collapsed: false, items: [ "guides/reference/node-config-methods", "guides/reference/node-config-options", diff --git a/static/img/xmtp-mark-black.svg b/static/img/xmtp-mark-black.svg deleted file mode 100644 index 0c0ce0c..0000000 --- a/static/img/xmtp-mark-black.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/static/img/xmtp-mark-white.svg b/static/img/xmtp-mark-white.svg deleted file mode 100644 index be6f26b..0000000 --- a/static/img/xmtp-mark-white.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - -