From ef0b238a8d4d51a262173b695b3ac3bfaa059c26 Mon Sep 17 00:00:00 2001 From: LordGhostX <47832826+LordGhostX@users.noreply.github.com> Date: Wed, 5 Jun 2024 21:43:48 +0100 Subject: [PATCH] add all the community links (#197) --- docs/guides/nwaku/run-docker-compose.md | 10 +++--- docusaurus.config.js | 44 ++++++++++++++----------- 2 files changed, 29 insertions(+), 25 deletions(-) diff --git a/docs/guides/nwaku/run-docker-compose.md b/docs/guides/nwaku/run-docker-compose.md index bc47ce2..d61ea72 100644 --- a/docs/guides/nwaku/run-docker-compose.md +++ b/docs/guides/nwaku/run-docker-compose.md @@ -24,7 +24,7 @@ Check out the [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to learn h - [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.01 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) (~0.6 Sepolia ETH) - A password to protect your RLN membership :::info @@ -40,7 +40,7 @@ cd nwaku-compose ## Configure the setup -Docker Compose [reads the ./.env file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#additional-information-3) from the filesystem. You can use `.env.example` as a template to provide the above values. The recommended process for working with `.env` files is to duplicate `.env.example`, rename it as `.env`, and then make the necessary value edits. +Docker Compose [reads the .env file](https://docs.docker.com/compose/environment-variables/set-environment-variables/#additional-information-3) from the filesystem. You can use `.env.example` as a template to provide the configuration values. The recommended process for working with `.env` files is to duplicate `.env.example`, rename it as `.env`, and then make the necessary value edits. ```shell cp .env.example .env @@ -48,20 +48,20 @@ ${EDITOR} .env ``` :::caution -Ensure that you do **NOT** include any secrets in the `.env.example` file, as it could accidentally be shared in the Git repository. +Ensure that you do **NOT** include any secrets in the `.env.example` file, as it could accidentally be shared in your Git repository. ::: ## Register for RLN membership The RLN membership is your access key to The Waku Network. Its registration is done on-chain, allowing your `nwaku` node to send messages decentralised and privately, respecting some rate limits. Other peers won't relay messages that exceed the rate limit. -This command registers your membership and saves it in the `keystore/keystore.json` file: +This command registers your membership and saves it in the `keystore/keystore.json` file. You should have Docker running at this step: ```shell ./register_rln.sh ``` -:::info +:::tip If you only want to relay traffic without sending messages to the network, you don't need to register for RLN membership. ::: diff --git a/docusaurus.config.js b/docusaurus.config.js index f57fa09..9d4f333 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -103,10 +103,6 @@ const config = { { title: "Guides", items: [ - { - to: "/", - label: "Getting Started", - }, { to: "/guides/nwaku/run-docker-compose", label: "Run a Nwaku Node", @@ -120,35 +116,39 @@ const config = { { title: "Community", items: [ - { - href: "https://discord.waku.org/", - label: "Discord", - }, { href: "https://twitter.com/waku_org/", label: "X", }, + { + href: "https://discord.waku.org/", + label: "Discord", + }, + { + href: "https://github.com/waku-org/", + label: "GitHub", + }, + { + href: "https://www.youtube.com/@wakuorg", + label: "YouTube", + }, + { + href: "https://www.linkedin.com/company/waku-org", + label: "LinkedIn", + }, + { + href: "https://warpcast.com/waku", + label: "Farcaster", + }, { href: "https://t.me/waku_org/", label: "Telegram", }, - { - href: "https://forum.vac.dev/", - label: "Vac Forum", - }, - { - href: "https://github.com/waku-org/bounties/", - label: "Bounties", - }, ], }, { title: "Resources", items: [ - { - href: "https://github.com/waku-org/", - label: "GitHub", - }, { href: "https://blog.waku.org/", label: "Blog", @@ -157,6 +157,10 @@ const config = { href: "https://rfc.vac.dev/waku", label: "Waku RFCs", }, + { + href: "https://github.com/waku-org/bounties/", + label: "Bounties", + }, { href: "https://github.com/waku-org/awesome-waku/", label: "Awesome Waku",