Skip to content

Commit

Permalink
US -> UK English rewrite (#99)
Browse files Browse the repository at this point in the history
* rewrite US to UK English

* unpublish react guide
  • Loading branch information
LordGhostX authored Aug 1, 2023
1 parent 677718f commit 11f3ae9
Show file tree
Hide file tree
Showing 39 changed files with 147 additions and 144 deletions.
31 changes: 17 additions & 14 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
{
"version": "0.2",
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json",
"language": "en",
"language": "en-GB",
"words": [
"linkability",
"Unlinkability",
"unlinkability",
"waku",
"gossipsub",
"incentivized",
"incentivizing",
"incentivised",
"incentivising",
"incentivisation",
"RAILGUN",
"nwaku",
"deanonymization",
"deanonymisation",
"ECIES",
"enrtree",
"Discv5",
"Gossipsub",
"LIGHTPUSH",
"gossipsub",
"lightpush",
"pubtopic1",
"proto",
"multiaddr",
"multiaddrs",
"keyturn",
"Protobuf",
"protobuf",
"supercrypto",
"QUIC",
"Dappnode",
"dappnode",
"gameplay",
"Smol",
"Datagram",
"Graphcast",
"smol",
"datagram",
"graphcast",
"permissionless",
"Royer",
"Secureum",
Expand All @@ -43,7 +43,7 @@
"myaddr",
"extip",
"staticnode",
"Secp",
"secp",
"libpq",
"dylib",
"uncompromised",
Expand All @@ -53,6 +53,9 @@
"Václav",
"Pavlín",
"Revuelta",
"trilemma",
"Alvaro",
"keyturn",
],
"flagWords": [],
"ignorePaths": [
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ presets: [

This should suffice since Logos plugins will handle other configurations linked to the designated business unit. However, if you encounter any inaccuracies in the data provided by Logos Plugins, please visit the [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) page and submit an issue.

## Customization
## Customisation

You can find the instructions on adding more documentation sections, localization, and versioning on the [Docusaurus](https://docusaurus.io/docs) website.
You can find the instructions on adding more documentation sections, localisation, and versioning on the [Docusaurus](https://docusaurus.io/docs) website.

> Note that theme customization is limited; for further instructions on customizing your theme, head over to [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/).
> Note that theme customisation is limited; for further instructions on customizing your theme, head over to [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/).
## Troubleshooting

Expand Down
12 changes: 6 additions & 6 deletions diagrams/_discv5.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ sequenceDiagram
```

1. DNS Discovery protocol is executed.
2. Alice's retrieves Bob's ENR (Ethereum Node Record) from DNS Server.
3. Alice executes Discv5 protocol with Bob using UDP connection details from ENR.
2. Alice retrieves Bob's ENR (Ethereum Node Record) from DNS Server.
3. Alice executes the Discv5 protocol with Bob using UDP connection details from ENR.
4. Bob returns Carol's, David's and Erin's ENRs to Alice.
5. Alice Decodes ENRs and extracts Carol's, David's and Erin's TCP and UDP connections details.
6. Alice executes Discv5 protocol with Carol using UDP connection details from ENR.
5. Alice decodes ENRs and extracts the details of Carol, David, and Erin's TCP and UDP connections.
6. Alice executes the Discv5 protocol with Carol using UDP connection details from ENR.
7. Carol returns Frank's, Gwen's and Harry's ENRs to Alice.
8. Alice Decodes ENRs and extracts Frank's, Gwen's and Harry's TCP and UDP connections details.
8. Alice decodes ENRs and extracts Frank's, Gwen's and Harry's TCP and UDP connection details.
9. Alice selects to dial David, Frank and Gwen.
10. Alice dials David, Frank and Gwen over libp2p using TCP connections details from ENRs.
10. Alice dials David, Frank and Gwen over libp2p using TCP connection details from ENRs.
8 changes: 4 additions & 4 deletions diagrams/_dns-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ sequenceDiagram
```

1. DNS lookup query to retrieve TXT data stored on `example.com` domain.
2. `entree-root` is returned, value of `e` is the `enr-root`, root hash of the node subtree.
2. `enrtree-root` is returned, and the value of `e` is the `enr-root`, the root hash of the node subtree.
3. DNS lookup query to retrieve TXT data stored on `<enr-root>.example.com` domain.
4. `entree-branch` is returned, this tree contains hashes of node subtrees.
5. DNS lookup query to retrieve TXT data stored on, `DU...VQ.example.com` domain, the first leaf of `entree-branch`.
4. `enrtree-branch` is returned; this tree contains hashes of node subtrees.
5. DNS lookup query to retrieve TXT data stored on `DU...VQ.example.com` domain, the first leaf of `enrtree-branch`.
6. `enr` record is returned.
7. Returned value is decoded, peer connection details such as ip address and port are learned.
7. Returned value is decoded, and peer connection details such as IP address and port are learned.
8 changes: 4 additions & 4 deletions diagrams/_peer-exchange.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ sequenceDiagram
```

1. DNS Discovery protocol is executed.
2. Alice's retrieves Bob's websocket multiaddr from DNS Server.
2. Alice retrieves Bob's websocket multiaddr from DNS Server.
3. Alice dials Bob using libp2p protocols.
4. Alice executes a Peer Exchange Query to Bob.
4. Alice executes a Peer Exchange query to Bob.
5. Bob returns Carol's and David's ENR to Alice.
6. Alice Decodes ENRs and extracts Carol's and David's websocket multiaddrs.
6. Alice decodes ENRs and extracts Carol's and David's websocket multiaddrs.
7. Alice dials Carol and David.
8. Alice can now drop the connection with Bob (bootstrap node), Alice has 2 connections to the Waku Network.
8. Alice can now drop the connection with Bob (bootstrap node); Alice has 2 connections to the Waku Network.
2 changes: 1 addition & 1 deletion diagrams/_protocol-interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ The Pub/Sub topic `pubtopic1` serves as a means of routing messages (the network
1. Node A creates a WakuMessage `msg1` with [Content Topic](/overview/concepts/content-topics) `contentTopic1`.
2. Node F requests to get messages filtered by Pub/Sub topic `pubtopic1` and Content Topic `contentTopic1`. Node D subscribes F to this filter and will forward messages that match that filter in the future.
3. Node A publishes `msg1` on `pubtopic1`. The message is sent from Node A to Node B and then forwarded to Node D.
4. Node D, upon receiving `msg1` both stores the message for future retrieval by other nodes and forwards it to Node C.
4. Node D, upon receiving `msg1`, stores the message for future retrieval by other nodes and forwards it to Node C.
5. Node D also pushes `msg1` to Node F, informing it about the arrival of a new message.
6. At a later time, Node E comes online and requests messages matching `pubtopic1` and `contentTopic1` from Node D. Node D responds with `msg1` and potentially other messages that match the query.
4 changes: 2 additions & 2 deletions docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title: Join Our Community
---

Welcome to the Waku Community! Whether you are interested in building with Waku, contributing to the network, expanding your knowledge, or staying up-to-date with our progress, we have something for everyone.
Welcome to the Waku Community! Whether you are interested in building with Waku, contributing to the network, expanding your knowledge, or staying abreast of our progress, we have something for everyone.

## [Discord](https://discord.waku.org/)

Connect with like-minded individuals in the Waku ecosystem! Introduce yourself, join developer conversations, or seek assistance. Join the [Waku Discord](https://discord.waku.org/) today!

## [Twitter](https://twitter.com/waku_org)

Stay informed and updated with the latest news and insights from Waku. [Follow us on Twitter](https://twitter.com/waku_org) now for all the exciting updates!
Stay informed and updated with the latest news and insights from Waku. [Follow us on Twitter](https://twitter.com/waku_org) now for all the thrilling updates!

## [Telegram](https://t.me/waku_org)

Expand Down
10 changes: 5 additions & 5 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Get involved in Waku's open-source initiatives to improve the protocols, SDKs, d

- [Running a node](/guides/nodes-and-sdks#run-a-waku-node) within your application.
- [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team.
- Completing [Waku Bounties](#complete-waku-bounties) and participating in our [Bug Bounty Program](#submit-security-bug-reports).
- Completing [Waku Bounties](#complete-waku-bounties) and participating in our [Bug Bounty Programme](#submit-security-bug-reports).
- Inspiring other developers to explore and use Waku for [various use cases](/overview/use-cases).

Begin your journey by visiting the [Nodes and SDKs](/guides/nodes-and-sdks) guide and start building on Waku today!
Expand All @@ -17,21 +17,21 @@ To report a bug, create an issue in the appropriate [GitHub repository](https://

## Suggest a Feature

To suggest a new feature, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the feature and specify the use cases the feature can enable, allowing us to investigate and prioritize accordingly.
To suggest a new feature, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the feature and specify the use cases the feature can enable, allowing us to investigate and prioritise accordingly.

## Make Pull Requests

Community pull requests (PRs) are highly encouraged, but we recommend [suggesting a feature](#suggest-a-feature) first to gauge interest and gather feedback before proceeding with a PR.

## Complete Waku Bounties

To promote community contributions, we encourage members to complete bounties that benefit Waku and earn rewards while positively impacting the network. Join the bounty program at: <https://github.com/waku-org/bounties>.
To promote community contributions, we encourage members to complete bounties that benefit Waku and earn rewards while positively impacting the network. Join the bounty programme at: <https://github.com/waku-org/bounties>.


## Submit Security Bug Reports

To improve Waku's security, we invite researchers to collaborate in identifying and resolving potential vulnerabilities and earn rewards for their efforts. To participate, please review our bug bounty program's details and submit your reports at: <https://hackenproof.com/status-dot-im/waku>.
To improve Waku's security, we invite researchers to collaborate in identifying and resolving potential vulnerabilities and earn rewards for their efforts. To participate, please review our bug bounty programme's details and submit your reports at: <https://hackenproof.com/status-dot-im/waku>.

## Contribute to Waku Research

Waku Research is an innovative R&D project dedicated to developing modular peer-to-peer protocols for communication that prioritize privacy, security, and censorship resistance. Explore Waku's ongoing challenges and experimental code at <https://github.com/waku-org/research>.
Waku Research is an innovative R&D project dedicated to developing modular peer-to-peer protocols for communication that prioritise privacy, security, and censorship resistance. Explore Waku's ongoing challenges and experimental code at <https://github.com/waku-org/research>.
5 changes: 3 additions & 2 deletions docs/guides/js-waku/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,16 @@ import "https://cdn.jsdelivr.net/npm/protobufjs@latest/dist/protobuf.min.js";

## Getting Started

Check out the quick start guide and comprehensive tutorials to learn how to build applications using `@waku/sdk`:
Have a look at the quick start guide and comprehensive tutorials to learn how to build applications using `@waku/sdk`:

| Guide | Description |
| - | - |
| [Send and Receive Messages Using Light Push and Filter](/guides/js-waku/light-send-receive) | Learn how to send and receive messages on light nodes using the [Light Push](/overview/concepts/protocols#light-push) and [Filter](/overview/concepts/protocols#filter) protocols |
| [Retrieve Messages Using Store](/guides/js-waku/store-retrieve-messages) | Learn how to retrieve and filter historical messages on light nodes using the [Store](/overview/concepts/protocols#store) protocol |
| [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) | Learn how to use the [@waku/react](https://www.npmjs.com/package/@waku/react) package seamlessly integrate `@waku/sdk` into a React application |
| [Bootstrap DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) | Learn how to use the [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) package to bootstrap your next `@waku/sdk` project from various example templates |

<!-- | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) | Learn how to use the [@waku/react](https://www.npmjs.com/package/@waku/react) package seamlessly integrate `@waku/sdk` into a React application | -->

## Get Help and Report Issues

To engage in general discussions, seek assistance, or stay updated with the latest news, visit the `#support` and `#js-waku-contribute` channels on the [Waku Discord](https://discord.waku.org).
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/js-waku/light-send-receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Send and Receive Messages Using Light Push and Filter
---

This guide provides detailed steps to start using the `@waku/sdk` package by setting up a Light Node to send messages using the [Light Push protocol](/overview/concepts/protocols#light-push), and receive messages using the [Filter protocol](/overview/concepts/protocols#filter). Check out the [installation guide](/guides/js-waku/#installation) for steps on adding `@waku/sdk` to your project.
This guide provides detailed steps to start using the `@waku/sdk` package by setting up a Light Node to send messages using the [Light Push protocol](/overview/concepts/protocols#light-push), and receive messages using the [Filter protocol](/overview/concepts/protocols#filter). Have a look at the [installation guide](/guides/js-waku/#installation) for steps on adding `@waku/sdk` to your project.

## Create a Light Node

Expand Down Expand Up @@ -89,7 +89,7 @@ const ChatMessage = new protobuf.Type("ChatMessage")
```

:::info
Check out the [Protobuf installation](/guides/js-waku/#message-structure) guide for adding the `protobufjs` package to your project.
Have a look at the [Protobuf installation](/guides/js-waku/#message-structure) guide for adding the `protobufjs` package to your project.
:::

## Send Messages Using Light Push
Expand All @@ -104,12 +104,12 @@ const protoMessage = ChatMessage.create({
message: "Hello, World!",
});

// Serialize the message using Protobuf
const serializedMessage = ChatMessage.encode(protoMessage).finish();
// Serialise the message using Protobuf
const serialisedMessage = ChatMessage.encode(protoMessage).finish();

// Send the message using Light Push
await node.lightPush.send(encoder, {
payload: serializedMessage,
payload: serialisedMessage,
});
```

Expand All @@ -135,5 +135,5 @@ const unsubscribe = await node.filter.subscribe([decoder], callback);
```

:::tip Congratulations!
You have successfully sent and received messages over the Waku Network using the `Light Push` and `Filter` protocols. Check out the [light-js](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-js) and [light-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-chat) examples for working demos.
You have successfully sent and received messages over the Waku Network using the `Light Push` and `Filter` protocols. Have a look at the [light-js](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-js) and [light-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-chat) examples for working demos.
:::
6 changes: 3 additions & 3 deletions docs/guides/js-waku/store-retrieve-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const storeQuery = node.store.queryGenerator([decoder]);

// Process the messages
for await (const messagesPromises of storeQuery) {
// Fulfill the messages promises
// Fulfil the messages promises
const messages = await Promise.all(messagesPromises
.map(async (p) => {
const msg = await p;
Expand Down Expand Up @@ -193,9 +193,9 @@ const storeQuery = node.store.queryGenerator([decoder, options]);
```

:::info
The `timeFilter` option significantly reduces message retrieval performance. To optimize it, consider resuming message retrieval using a [cursor](#cursor) that starts from the last seen message.
The `timeFilter` option significantly reduces message retrieval performance. To optimise it, consider resuming message retrieval using a [cursor](#cursor) that starts from the last seen message.
:::

:::tip Congratulations!
You have successfully retrieved and filtered historical messages on a Light Node using the `Store` protocol. Check out 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.
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.
:::
4 changes: 2 additions & 2 deletions docs/guides/js-waku/use-waku-create-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide provides detailed steps to bootstrap your next `@waku/sdk` project fr

## Usage

Initialize a new `@waku/sdk` template using any of the following methods:
Initialise a new `@waku/sdk` template using any of the following methods:

```mdx-code-block
import Tabs from '@theme/Tabs';
Expand All @@ -30,7 +30,7 @@ yarn create @waku/app [PROJECT DIRECTORY]
</TabItem>
</Tabs>

Next, select a template to initialize your app from:
Next, select a template to initialise your app from:

![waku create app demo](/img/waku-create-app-demo.gif)

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/js-waku/use-waku-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,9 @@ function App() {
```

:::info
To explore the available query options, check out the [Store Query Options](/guides/js-waku/store-retrieve-messages#store-query-options) guide.
To explore the available query options, have a look at the [Store Query Options](/guides/js-waku/store-retrieve-messages#store-query-options) guide.
:::

:::tip
You have successfully integrated `@waku/sdk` into a React application using the `@waku/react` package. Check out the [web-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/web-chat) example for a working demo.
You have successfully integrated `@waku/sdk` into a React application using the `@waku/react` package. Have a look at the [web-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/web-chat) example for a working demo.
:::
4 changes: 2 additions & 2 deletions docs/guides/nodes-and-sdks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Ready to integrate Waku into your application for private, secure, censorship-fr

## Run a Waku Node

The Waku Network is a decentralized, permissionless system where anyone can run nodes, use the network, and contribute to its support.
The Waku Network is a decentralised, permissionless system where anyone can run nodes, use the network, and contribute to its support.

| | Description | Documentation |
| - | - | - |
Expand Down Expand Up @@ -43,6 +43,6 @@ Waku provides integrations tailored for mobile applications, enabling Waku to ru
| | Description | Documentation |
| - | - | - |
| JSON-RPC API | `JSON-RPC` API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | COMING SOON |
| [@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) |
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | COMING SOON |
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `@waku/sdk` project from various example templates | [Bootstrap DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) |
| [nwaku-compose](https://github.com/alrevuelta/nwaku-compose) | Pre-configured Docker Compose setup for running and monitoring a `nwaku` node using Prometheus and Grafana | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) |
Loading

0 comments on commit 11f3ae9

Please sign in to comment.