From 66aef1b1de15ec6addf251fb74c44a2bb708f3d9 Mon Sep 17 00:00:00 2001 From: LordGhostX <47832826+LordGhostX@users.noreply.github.com> Date: Tue, 5 Mar 2024 09:30:38 +0100 Subject: [PATCH] resolve docs issues for nwaku logs and idea board visibility (#174) --- docs/guides/getting-started.md | 10 +++++++--- docs/guides/nwaku/run-docker-compose.md | 8 +++++++- sidebars.js | 8 ++++++-- 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index e58fe86..c6cb372 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -16,8 +16,8 @@ The Waku Network is a decentralised, permissionless system where anyone can run | | Description | Documentation | | - | - | - | -| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [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 | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) | +| [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 | ## Integrate using SDKs @@ -46,4 +46,8 @@ Waku provides integrations tailored for mobile applications, enabling Waku to ru | | 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) | \ No newline at end of file +| [@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. +::: \ No newline at end of file diff --git a/docs/guides/nwaku/run-docker-compose.md b/docs/guides/nwaku/run-docker-compose.md index 3a52ce1..c8e242d 100644 --- a/docs/guides/nwaku/run-docker-compose.md +++ b/docs/guides/nwaku/run-docker-compose.md @@ -16,7 +16,7 @@ This guide provides detailed steps to configure, run, monitor, and interact with - [Git](https://git-scm.com/) or [GitHub Desktop](https://desktop.github.com/) - [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) - [Ethereum Sepolia WebSocket Endpoint](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#3-access-a-node-on-the-sepolia-testnet-using-infura) -- [Wallet with Sepolia Ethereum](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#2-obtain-sepolia-eth-from-faucet) (less than 0.1 Sepolia ETH) +- [Wallet with Sepolia Ethereum](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/pre-requisites-of-running-on-chain-spam-protected-chat2.md#2-obtain-sepolia-eth-from-faucet) (less than 0.01 Sepolia ETH) - A password to protect your RLN membership ## Clone the repository @@ -61,6 +61,12 @@ Start all processes: `nwaku` node, database for storing messages, and Grafana fo docker-compose up -d ``` +View the logs of the node to confirm that it is running correctly: + +```shell +docker-compose logs -f nwaku +``` + ## Interact with the node Visit to view your node metrics in real time. diff --git a/sidebars.js b/sidebars.js index 5be6b78..08238ce 100644 --- a/sidebars.js +++ b/sidebars.js @@ -12,9 +12,9 @@ const sidebars = { id: "guides/nwaku/run-node", }, items: [ - "guides/nwaku/build-source", - "guides/nwaku/run-docker", "guides/nwaku/run-docker-compose", + "guides/nwaku/run-docker", + "guides/nwaku/build-source", "guides/nwaku/configure-discovery", "guides/nwaku/configure-nwaku", "guides/nwaku/config-methods", @@ -84,6 +84,10 @@ const sidebars = { "learn/research", "learn/waku-vs-libp2p", "learn/glossary", + { + type: 'html', + value: 'Waku Idea Board', + }, ], research: [ {