From a4a8dee34c36e0c1dd14244c30035233c711a997 Mon Sep 17 00:00:00 2001 From: vuittont60 <81072379+vuittont60@users.noreply.github.com> Date: Thu, 11 Jan 2024 22:38:56 +0800 Subject: [PATCH] docs: fix typo (#2348) --- docs/api/node.md | 2 +- docs/operators/how-to/configure-domain.md | 2 +- docs/operators/how-to/connect.md | 2 +- docs/operators/how-to/run.md | 2 +- docs/tutorial/dingpu.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/node.md b/docs/api/node.md index 740c2dac8..af5cfa229 100644 --- a/docs/api/node.md +++ b/docs/api/node.md @@ -2,7 +2,7 @@ ## Nim API -The Nim Waku API consist of a set of methods opearting on the Waku Node object. +The Nim Waku API consist of a set of methods operating on the Waku Node object. Some of them have different arity depending on what privacy/bandwidth trade-off the consumer wants to make. These methods are: diff --git a/docs/operators/how-to/configure-domain.md b/docs/operators/how-to/configure-domain.md index dee1f8bce..226da4b2c 100644 --- a/docs/operators/how-to/configure-domain.md +++ b/docs/operators/how-to/configure-domain.md @@ -10,7 +10,7 @@ It is possible to configure an IPv4 DNS domain name that resolves to the node's wakunode2 --dns4-domain-name=mynode.example.com ``` -This allows for the node's publically announced `multiaddrs` to use the `/dns4` scheme. +This allows for the node's publicly announced `multiaddrs` to use the `/dns4` scheme. In addition, nodes with domain name and [secure websocket configured](./configure-websocket.md), will generate a discoverable ENR containing the `/wss` multiaddr with `/dns4` domain name. This is necessary to verify domain certificates when connecting to this node over secure websocket. \ No newline at end of file diff --git a/docs/operators/how-to/connect.md b/docs/operators/how-to/connect.md index a75da1157..80f63958d 100644 --- a/docs/operators/how-to/connect.md +++ b/docs/operators/how-to/connect.md @@ -1,6 +1,6 @@ # Connect to other peers -*Note that this tutorial describes how to **configure** a node to connect to other peers before runnning the node. +*Note that this tutorial describes how to **configure** a node to connect to other peers before running the node. For connecting a running node to existing peers, see the [JSON-RPC API](https://rfc.vac.dev/spec/16/).* diff --git a/docs/operators/how-to/run.md b/docs/operators/how-to/run.md index 4cfde3285..311087b1e 100644 --- a/docs/operators/how-to/run.md +++ b/docs/operators/how-to/run.md @@ -36,7 +36,7 @@ Different ways to connect to other nodes are expanded upon in our [connection gu Find the log entry beginning with `Listening on`. It should be printed at INFO level when you start your node -and contains a list of all publically announced listening addresses for the nwaku node. +and contains a list of all publicly announced listening addresses for the nwaku node. For example diff --git a/docs/tutorial/dingpu.md b/docs/tutorial/dingpu.md index a4a386b69..8306ffdfe 100644 --- a/docs/tutorial/dingpu.md +++ b/docs/tutorial/dingpu.md @@ -21,7 +21,7 @@ Then type messages to publish. ## Interactively add a node -There is also an interactive mode. Type `/connect` then paste address of other node. However, this currently has some timing issues with mesh not being updated, so it is adviced not to use this until this has been addressed. See https://github.com/waku-org/nwaku/issues/231 +There is also an interactive mode. Type `/connect` then paste address of other node. However, this currently has some timing issues with mesh not being updated, so it is advised not to use this until this has been addressed. See https://github.com/waku-org/nwaku/issues/231 ## Dingpu cluster node