docs: fix typos (#569)

* docs: fix typos

* Correct notary readme link.

---------

Co-authored-by: yuroitaki <>

crates/common/src/config.rs

@@ -7,9 +7,9 @@ use std::error::Error;
 
 use crate::Role;
 
-/// Default for the maximum number of bytes that can be sent (4Kb).
+/// Default for the maximum number of bytes that can be sent (4KB).
 pub const DEFAULT_MAX_SENT_LIMIT: usize = 1 << 12;
-/// Default for the maximum number of bytes that can be received (16Kb).
+/// Default for the maximum number of bytes that can be received (16KB).
 pub const DEFAULT_MAX_RECV_LIMIT: usize = 1 << 14;
 
 // Extra cushion room, eg. for sharing J0 blocks.
@@ -25,7 +25,7 @@ static VERSION: Lazy<Version> = Lazy::new(|| {
         .unwrap()
 });
 
-/// Protocol configuration to be setup initially by prover and verifier.
+/// Protocol configuration to be set up initially by prover and verifier.
 #[derive(derive_builder::Builder, Clone, Debug, Deserialize, Serialize)]
 pub struct ProtocolConfig {
     /// Maximum number of bytes that can be sent.
@@ -73,7 +73,7 @@ impl ProtocolConfig {
 }
 
 /// Protocol configuration validator used by checker (i.e. verifier) to perform compatibility check
-/// with the peer (i.e. prover)'s configuration.
+/// with the peer's (i.e. the prover's) configuration.
 #[derive(derive_builder::Builder, Clone, Debug)]
 pub struct ProtocolConfigValidator {
     /// Maximum number of bytes that can be sent.

crates/examples/discord/discord_dm.rs

@@ -66,7 +66,7 @@ async fn main() {
         .await
         .unwrap();
 
-    // Setup protocol configuration for prover.
+    // Set up protocol configuration for prover.
     let protocol_config = ProtocolConfig::builder()
         .max_sent_data(MAX_SENT_DATA)
         .max_recv_data(MAX_RECV_DATA)

crates/notary/server/README.md

@@ -109,7 +109,7 @@ To perform a notarization, some parameters need to be configured by the prover a
 To streamline this process, a single HTTP endpoint (`/session`) is used by both TCP and WebSocket clients.
 
 #### Notarization
-After calling the configuration endpoint above, the prover can proceed to start the notarization. For a TCP client, that means calling the `/notarize` endpoint using HTTP (`https`), while a WebSocket client should call the same endpoint but using WebSocket (`wss`). Example implementations of these clients can be found in the [integration test](../notary-tests-integration/tests/notary.rs).
+After calling the configuration endpoint above, the prover can proceed to start the notarization. For a TCP client, that means calling the `/notarize` endpoint using HTTP (`https`), while a WebSocket client should call the same endpoint but using WebSocket (`wss`). Example implementations of these clients can be found in the [integration test](../tests-integration/tests/notary.rs).
 
 #### Signatures
 Currently, both the private key (and cert) used to establish a TLS connection with the prover, and the private key used by the notary server to sign the notarized transcript, are hardcoded PEM keys stored in this repository. Though the paths of these keys can be changed in the config (`notary-key` field) to use different keys instead.

crates/prover/src/tls/mod.rs

@@ -86,7 +86,7 @@ impl Prover<state::Initialized> {
             )
             .await?;
 
-        // Sends protocol configuration to verifier for compatibility check
+        // Sends protocol configuration to verifier for compatibility check.
         mux_fut
             .poll_with(async {
                 io.send(self.config.protocol_config().clone()).await?;

crates/verifier/src/tls/mod.rs

@@ -74,7 +74,7 @@ impl Verifier<state::Initialized> {
             )
             .await?;
 
-        // Receives protocol configuration from prover to perform compatibility check
+        // Receives protocol configuration from prover to perform compatibility check.
         let protocol_config = mux_fut
             .poll_with(async {
                 let peer_configuration: ProtocolConfig = io.expect_next().await?;