diff --git a/README.md b/README.md index 54585e56..dcab9586 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ to other services to interchange information through a specified messaging API. ### Service architecture Most of the services are implemented with the same idea behind. There is a front layer responsible for handling the `Overwatch` service -and a back layer that implement the actual service logic. +and a back layer that implements the actual service logic. This allows us to easily replace components as needed in a type level system. In any case, a node can be setup in a declarative way composing the types. For example: diff --git a/consensus-engine/README.md b/consensus-engine/README.md index c1f389ad..e5dc064d 100644 --- a/consensus-engine/README.md +++ b/consensus-engine/README.md @@ -43,7 +43,7 @@ cc c2157c559fe10276985a8f2284b0c294c2d6a5a293cce45f2e4ad2a3b4a23233 # shrinks to ``` We should manually check if the error is caused by consensus-engine, or by something wrong in the fuzz test. -If the error is came from consensus-engine, we should fix the consensus-engine and commit the fix to Git along with the regression file. +If the error came from consensus-engine, we should fix the consensus-engine and commit the fix to Git along with the regression file. If the fuzz test starts with the regression files existing, the files are automatically captured and used as test cases to check if the issue is not reproduced anymore. If the error is caused by something wrong in the fuzz test, we should fix the test. diff --git a/nodes/nomos-node/README.md b/nodes/nomos-node/README.md index cad343b3..d081648d 100644 --- a/nodes/nomos-node/README.md +++ b/nodes/nomos-node/README.md @@ -76,7 +76,7 @@ If you are a node operator who wants to run only a Nomos node (not a mixnode), you can configure the mixclient as the `Sender` mode (like `nomos-node-1` or `nomos-node-2` above). Then, the Nomos node sends messages to the mixnet instead of broadcasting them directly through libp2p gossipsub. -The mixclient in the `Sender` mode will splits a message into multiple Sphinx packets by constructing mix routes based on the mixnet topology configured, and sends packets to the mixnode. +The mixclient in the `Sender` mode will split a message into multiple Sphinx packets by constructing mix routes based on the mixnet topology configured, and sends packets to the mixnode. #### SenderReceiver mode diff --git a/nomos-services/http/examples/README.md b/nomos-services/http/examples/README.md index 982f0bb4..d19cfe13 100644 --- a/nomos-services/http/examples/README.md +++ b/nomos-services/http/examples/README.md @@ -8,7 +8,7 @@ To run this example use: cargo run --example axum --features http ``` -A GET enpoint will be registered at `http://localhost:8080/dummy/`. An endpoint corresponds with the Service name. +A GET endpoint will be registered at `http://localhost:8080/dummy/`. An endpoint corresponds with the Service name. ## Graphql.rs A demonstration of usage from within an overwatch service over the http. @@ -18,7 +18,7 @@ To run this example use: cargo run --example graphql --features http,gql ``` -An enpoint will be registered at `http://localhost:8080/dummygraphqlservice/`. An endpoint corresponds with the Service name. +An endpoint will be registered at `http://localhost:8080/dummygraphqlservice/`. An endpoint corresponds with the Service name. To query this endpoint use: ```bash diff --git a/testnet/README.md b/testnet/README.md index 1ef07fbf..4aa05278 100644 --- a/testnet/README.md +++ b/testnet/README.md @@ -56,7 +56,7 @@ Bootstrap node is accessible from the host via `3000` and `8080` ports. To expos - "8081-8190:8080" ``` -After running `docker compose up`, the randomlly assigned ports can be viewed with `ps` command: +After running `docker compose up`, the randomly assigned ports can be viewed with `ps` command: ```bash docker compose ps