From 5c969c54b8134242e032d9ee70f0dcb7b60b6310 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Mon, 13 May 2024 15:38:53 +0100 Subject: [PATCH] updates from Marina --- docs/guides/getting-started.md | 12 ++++++++---- docs/guides/nwaku/run-docker-compose.md | 4 ++++ docs/guides/nwaku/run-docker.md | 6 +++++- docs/guides/nwaku/run-node.md | 4 ++++ docs/learn/waku-network.md | 10 ++++++---- 5 files changed, 27 insertions(+), 9 deletions(-) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index a179cfa..0c16f31 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -16,7 +16,7 @@ graph LR W -->|Message 3| R2(Message Receiver 2) ``` - + :::tip Check out our [Learn section](/learn/waku-network), [YouTube channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes! @@ -43,7 +43,11 @@ Check out our [Learn section](/learn/waku-network), [YouTube channel](https://ww Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and [Awesome Waku](https://github.com/waku-org/awesome-waku/). ::: -## Run a Waku node +## Use cases + +## Get started + +### Run a Waku node Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide and [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to easily run a node. @@ -53,7 +57,7 @@ Waku is a decentralised, permissionless system where anyone can run a node, use If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord. ::: -## Integrate using SDKs +### Integrate using SDKs Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently. @@ -62,7 +66,7 @@ Waku is implemented in multiple SDKs, allowing it to integrate with different la | [@waku/sdk](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) | | [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) | -## Other integrations +### Other integrations | | Description | Documentation | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | diff --git a/docs/guides/nwaku/run-docker-compose.md b/docs/guides/nwaku/run-docker-compose.md index 8c6f69c..7f53431 100644 --- a/docs/guides/nwaku/run-docker-compose.md +++ b/docs/guides/nwaku/run-docker-compose.md @@ -117,6 +117,10 @@ curl --location 'http://127.0.0.1:8645/store/v1/messages?contentTopics=%2Fmy-app --header 'Accept: application/json' ``` +:::tip +If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord. +::: + :::tip Congratulations! You have successfully started a `nwaku` node with `RLN` enabled using Docker Compose. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) and [Advanced Configuration](https://github.com/waku-org/nwaku-compose/blob/master/ADVANCED.md) guides to learn how to configure `nwaku` for different use cases. ::: diff --git a/docs/guides/nwaku/run-docker.md b/docs/guides/nwaku/run-docker.md index be45ee1..c68b948 100644 --- a/docs/guides/nwaku/run-docker.md +++ b/docs/guides/nwaku/run-docker.md @@ -56,10 +56,14 @@ To find your public IP, use: dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}' ``` -:::tip +:::info We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers). ::: +:::tip +If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord. +::: + :::tip Congratulations! You have successfully built and started a `nwaku` node in a Docker container. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases. ::: diff --git a/docs/guides/nwaku/run-node.md b/docs/guides/nwaku/run-node.md index 3f4be47..ac44cd4 100644 --- a/docs/guides/nwaku/run-node.md +++ b/docs/guides/nwaku/run-node.md @@ -132,6 +132,10 @@ Node is healthy +:::tip +If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord. +::: + :::tip Congratulations! You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases. ::: diff --git a/docs/learn/waku-network.md b/docs/learn/waku-network.md index 1f95f28..224678f 100644 --- a/docs/learn/waku-network.md +++ b/docs/learn/waku-network.md @@ -10,10 +10,8 @@ The Waku Network is a shared p2p messaging network that is open-access, useful f 3. Automatic shard selection based on content topic. 4. Services for resource-restricted nodes, including historical message storage and retrieval, filtering, etc. -If you want to learn more about the Waku Network, the [WAKU2-NETWORK RFC](https://rfc.vac.dev/waku/standards/core/10/waku2) provides an in-depth look under the hood. - -:::info -The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage. +:::tip +If you want to learn more about the Waku Network, the [The Waku Network: Technical Overview](https://blog.waku.org/2024-waku-network-tech-overview) article provides an in-depth look under the hood. ::: ## Why join the Waku network? @@ -30,3 +28,7 @@ The public Waku Network replaces the previous experimental shared routing layer ## Running a Waku network node Have a look at the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide for instructions on running a [nwaku](https://github.com/waku-org/nwaku) node in the Waku Network. Use the Sepolia node and wallet you obtained above. + +:::info +The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage. +:::