reorganise docs

.cspell.json

@@ -80,6 +80,7 @@
     "baarerstrasse",
     "FDPIC",
     "IPFS",
+    "cheatsheet"
   ],
   "flagWords": [],
   "ignorePaths": [

docs/guides/getting-started.md

@@ -1,53 +1,93 @@
 ---
-title: Getting Started
+title: Introduction to Waku
 hide_table_of_contents: true
 slug: /
 ---
 
-:::caution
-Waku has risks and limitations as it is still developing and preparing for extensive adoption. However, it is already demonstrating its capabilities by powering various applications. [Join our community](https://waku.org/community/) to stay updated on our progress.
+Waku is a family of robust, censorship-resistant, peer-to-peer communication protocols that enable privacy-focused messaging for Web3 applications, allowing you to integrate decentralised communication features into your dApp without compromising security or privacy.
+
+```mermaid
+graph LR
+    S1(Message Sender 1) -->|Message 1| W(The Waku Network)
+    S2(Message Sender 2) -->|Message 2| W
+    S3(Message Sender 3) -->|Message 3| W
+    W -->|Message 1| R1(Message Receiver 1)
+    W -->|Message 2| R1
+    W -->|Message 3| R2(Message Receiver 2)
+```
+
+<div class="video-container">
+  <iframe class="yt-video" src="https://www.youtube.com/embed/nIWx5Vp_Qxk" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+</div>
+
+:::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!
 :::
 
-Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available SDKs and contribute by running a node.
+## What isn’t Waku?
+
+- Waku is not a blockchain but a network composed of protocols designed for Web3 communication, operating without the need for gas fees.
+- Waku is not just for messaging applications; it supports the development of complex applications that require secure and private data transmission.
+- Waku is not a long-term data storage network; it focuses on short, ephemeral, real-time messaging.
 
-## Run a Waku node
+## What can Waku be used for?
 
-The Waku Network is a decentralised, permissionless system where anyone can run nodes, use the network, and contribute to its support.
+1. **Chat Messengers**: Waku can be used to build private, decentralised chat apps resistant to censorship.
+2. **Voting and Proposals**: Exchange votes on proposals off-chain via Waku to save gas fees, then submit aggregated results to the blockchain.
+3. **NFT Marketplaces**: Use Waku to handle off-chain NFT bids and offers for gas savings, and to integrate social interactions like likes and comments.
+4. **State Channels**: Establish and maintain state channels with Waku, facilitating seamless message exchanges and updates without blockchain interaction.
+5. **Signature Exchange for Multi-Signature Wallets**: Allow multi-signature wallet owners to exchange signatures privately and securely through Waku.
+6. **Game Mechanics Communication**: Implement Waku as a communication layer for decentralised, peer-to-peer gaming, avoiding centralised infrastructure.
+7. **Layer 2 Coordination (Open Market, Spam Protected Mempool)**: Broadcast and aggregate Layer 2 transactions via Waku to enhance privacy and scalability, reducing network load.
+8. **Social Media Platforms**: Beyond chat messengers, use Waku for decentralised, censorship-resistant social media platforms like news feeds and multimedia sharing.
 
-| | Description | Documentation |
-| - | - | - |
-| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network | [Run a Nwaku Node](/guides/nwaku/run-node) |
-| [nwaku-compose](https://github.com/waku-org/nwaku-compose) | Pre-configured Docker Compose setup for running a RLN-enabled `nwaku` node with Grafana metrics dashboard (recommended) | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |
-| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | COMING SOON |
+:::tip
+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/).
+:::
 
-## Integrate using SDKs
+## Case studies
 
-Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
+<div class="case-study-container">
+  <a href="https://blog.waku.org/thegraph-waku-case-study/" target="_blank" rel="noopener noreferrer"><img src="/img/graph-use-case.jpeg" /></a>
+  <a href="https://blog.waku.org/railgun-waku-case-study/" target="_blank" rel="noopener noreferrer"><img src="/img/railgun-use-case.jpeg" /></a>
+</div>
 
-| | Description | Documentation |
-| - | - | - |
-| [@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) |
-| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | COMING SOON |
-| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | COMING SOON |
-| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | COMING SOON |
+## Getting started
+
+<div class="video-container">
+  <iframe class="yt-video two-items" src="https://www.youtube.com/embed/PYQaXCxUCwA" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 
-## Run on mobile devices
+  <iframe class="yt-video two-items" src="https://www.youtube.com/embed/sfmMcrbiX0c" title="Build a game using Waku Protocol" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+</div>
 
-Waku provides integrations tailored for mobile applications, enabling Waku to run efficiently on mobile devices.
+### Run a Waku node
 
-| | Description | Documentation |
-| - | - | - |
-| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | COMING SOON |
-| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | COMING SOON |
+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.
 
-## More integrations
+<div class="video-container">
+  <iframe class="yt-video" src="https://www.youtube.com/embed/fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+</div>
 
-| | Description | Documentation |
-| - | - | - |
-| [REST API](https://waku-org.github.io/waku-rest-api/) | REST API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | [Waku Node REST API Reference](https://waku-org.github.io/waku-rest-api/) |
-| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `@waku/sdk` project from various example templates | [Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) |
+:::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.
+:::
+
+### Integrate using SDKs
+
+Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
+
+|                                                          | Description                                                                         | Documentation                                                         |
+| -------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| [@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
+
+|                                                                    | Description                                                                            | Documentation                                                                |
+| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| [REST API](https://waku-org.github.io/waku-rest-api/)              | REST API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | [Waku Node REST API Reference](https://waku-org.github.io/waku-rest-api/)    |
+| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `@waku/sdk` project from various example templates  | [Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) |
 
 :::tip
-Check out the [Waku Idea Board](https://ideas.waku.org/) for creative project ideas and explore the limitless possibilities of the Waku protocol.
-:::
+Explore some example apps built using Waku at https://examples.waku.org/ and view a list of projects and workshops from previous hackathons at [Awesome Waku](https://github.com/waku-org/awesome-waku/).
+:::

docs/guides/js-waku/store-retrieve-messages.md

@@ -50,22 +50,19 @@ const decoder = createDecoder(contentTopic);
 
 The `store.queryWithOrderedCallback()` function provides a straightforward method for querying `Store` nodes and processing messages in chronological order through a callback function. It accepts these parameters:
 
-- `decoders`: List of `decoders` that specify the `content topic` to query for and their [message decryption](https://rfc.vac.dev/spec/26/) methods.
+- `decoders`: List of `decoders` that specify the `content topic` to query for and their [message decryption](https://rfc.vac.dev/waku/standards/application/26/payload) methods.
 - `callback`: The callback function for processing the retrieved messages.
 - `options` (optional): [Query options](/guides/js-waku/store-retrieve-messages#store-query-options) to filter the retrieved messages.
 
 ```js
 // Create the callback function
 const callback = (wakuMessage) => {
-	// Render the message/payload in your application
-	console.log(wakuMessage);
+  // Render the message/payload in your application
+  console.log(wakuMessage);
 };
 
 // Query the Store peer
-await node.store.queryWithOrderedCallback(
-	[decoder],
-	callback,
-);
+await node.store.queryWithOrderedCallback([decoder], callback);
 ```
 
 :::info
@@ -76,7 +73,7 @@ The `queryWithOrderedCallback()` function always returns the most recent message
 
 The `store.queryGenerator()` function provides more control and flexibility over processing messages retrieved from `Store` nodes through [Async Generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator). It accepts these parameters:
 
-- `decoders`: List of `decoders` that specify the `content topic` to query for and their [message decryption](https://rfc.vac.dev/spec/26/) methods.
+- `decoders`: List of `decoders` that specify the `content topic` to query for and their [message decryption](https://rfc.vac.dev/waku/standards/application/26/payload) methods.
 - `options` (optional): [Query options](/guides/js-waku/store-retrieve-messages#store-query-options) to filter the retrieved messages.
 
 ```js
@@ -85,14 +82,14 @@ const storeQuery = node.store.queryGenerator([decoder]);
 
 // Process the messages
 for await (const messagesPromises of storeQuery) {
-	// Fulfil the messages promises
-	const messages = await Promise.all(messagesPromises
-		.map(async (p) => {
-			const msg = await p;
-			// Render the message/payload in your application
-			console.log(msg);
-		})
-	);
+  // Fulfil the messages promises
+  const messages = await Promise.all(
+    messagesPromises.map(async (p) => {
+      const msg = await p;
+      // Render the message/payload in your application
+      console.log(msg);
+    })
+  );
 }
 ```
 
@@ -114,12 +111,12 @@ import { PageDirection } from "@waku/sdk";
 
 // Retrieve recent messages first
 const queryOptions = {
-	pageDirection: PageDirection.BACKWARD,
+  pageDirection: PageDirection.BACKWARD,
 };
 
 // Retrieve oldest messages first
 const queryOptions = {
-	pageDirection: PageDirection.FORWARD,
+  pageDirection: PageDirection.FORWARD,
 };
 
 // Query the Store peer with options
@@ -137,32 +134,25 @@ import { waku } from "@waku/sdk";
 // Create the callback function
 const messages = [];
 const callback = (wakuMessage) => {
-	messages.push(wakuMessage);
-	// Return "true" to stop retrieving pages
-	// Here, it retrieves only the first page
-	return true;
+  messages.push(wakuMessage);
+  // Return "true" to stop retrieving pages
+  // Here, it retrieves only the first page
+  return true;
 };
 
 // Retrieve the first page of messages
 // This retrieves all the messages if "return true" is not present
-await node.store.queryWithOrderedCallback(
-	[decoder],
-	callback,
-);
+await node.store.queryWithOrderedCallback([decoder], callback);
 
 // Create the cursor
 const lastMessage = messages[messages.length - 1];
 const cursor = await waku.createCursor(lastMessage);
 
 // Retrieve the next page of messages
 // The message at the cursor index is excluded from the result
-await node.store.queryWithOrderedCallback(
-	[decoder],
-	callback,
-	{
-		cursor: cursor,
-	},
-);
+await node.store.queryWithOrderedCallback([decoder], callback, {
+  cursor: cursor,
+});
 console.log(messages);
 ```
 
@@ -182,10 +172,10 @@ startTime.setDate(endTime.getDate() - 7);
 
 // Retrieve a week of messages
 const queryOptions = {
-	timeFilter: {
-		startTime,
-		endTime,
-	},
+  timeFilter: {
+    startTime,
+    endTime,
+  },
 };
 
 // Query the Store peer with options
@@ -199,4 +189,4 @@ The `timeFilter` option significantly reduces message retrieval performance. To
 
 :::tip Congratulations!
 You have successfully retrieved and filtered historical messages on a Light Node using the `Store` protocol. Have a look at the [store-js](https://github.com/waku-org/js-waku-examples/tree/master/examples/store-js) and [store-reactjs-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/store-reactjs-chat) examples for working demos.
-:::
+:::

docs/guides/nwaku/find-node-address.md

@@ -0,0 +1,60 @@
+---
+title: Find Your Node Address
+hide_table_of_contents: true
+---
+
+:::info
+When starting the node, `nwaku` will display all the public listening and discovery addresses at the `INFO` log level.
+:::
+
+You can find the addresses of a running node through its logs or by calling the [Get node info](https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info) endpoint of the [REST API](https://waku-org.github.io/waku-rest-api/).
+
+## Listening addresses
+
+Look for the log entry that begins with `Listening on`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 Listening on                               topics="waku node" tid=1623445 file=waku_node.nim:922 full=[/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn][/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn]
+```
+
+```shell
+# Listening TCP transport address
+/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
+
+# Listening WebSocket address
+/ip4/0.0.0.0/tcp/8000/ws/p2p/16Uiu2HAmQCsH9V81xoqTwGuT3qwkZWbwY1TtTQwpr3DjHU2TSwMn
+```
+
+## Discoverable ENR addresses
+
+A `nwaku` node can encode its addressing information in an [Ethereum Node Record (ENR)](https://eips.ethereum.org/EIPS/eip-778).
+
+### ENR for DNS discovery
+
+Look for the log entry that begins with `DNS: discoverable ENR`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 DNS: discoverable ENR                      topics="waku node" tid=1623445 file=waku_node.nim:923 enr=enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
+```
+
+```shell
+# ENR the node addresses are encoded in
+enr:-Iu4QBKYj8Ovxwz4fIalxZ_1a8dOCU2WC-1LQrcBCCb4Np93f9-UuSZXn3vagJL1S3k3hwRYfOp3JSbW7_VqwtqMIeMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQOrmyV59dAzY4ZKrvrj32VOoZbLby8dCKFnXnqhIdQ0NYN0Y3CC6mCFd2FrdTIB
+```
+
+### ENR for Discv5
+
+Look for the log entry that begins with `Discv5: discoverable ENR`, for example:
+
+```txt title="Nwaku Log Output"
+INF 2023-06-15 16:09:54.448+01:00 Discv5: discoverable ENR                   topics="waku node" tid=1623445 file=waku_node.nim:924 enr=enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+```shell
+# ENR the node addresses are encoded in
+enr:-IO4QDxToTg86pPCK2KvMeVCXC2ADVZWrxXSvNZeaoa0JhShbM5qed69RQz1s1mWEEqJ3aoklo_7EU9iIBcPMVeKlCQBgmlkgnY0iXNlY3AyNTZrMaEDdBHK1Gx6y_zv5DVw5Qb3DtSOMmVHTZO1WSORrF2loL2DdWRwgiMohXdha3UyAw
+```
+
+:::tip Congratulations!
+You have successfully found the listening and discoverable addresses for your `nwaku` node. Have a look at the Configure Peer Discovery](/guides/nwaku/configure-discovery) guide to learn how to discover and connect with peers in the network.
+:::