From 8c6d4f075647802e2029f5c2bd4223fbf407185a Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Tue, 27 Jun 2023 23:38:21 +0100 Subject: [PATCH] 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 @@ - - - - - - - - - -