[doc] fix typos (#556)

Author: bird-dancer

README.md

@@ -12,7 +12,7 @@ The diagram represents the main components of the software and how they interact
 
 - Sequencer: A sequencer assembles a set of input messages of the same project as a task and assigns the task to a prover. It receives messages from clients, persists them in data availability (DA), and packs them into tasks. The tasks will be sent to prover to generate proves, and the returned proves will be output to destination defined by the project.
 - Prover: A prover generates proves with ZK virtual machines. It contains a task processor, ZK runtime manager, project manager. Receiving a task, the prover constructs a ZK runtime instance according to the corresponding project config and generates a ZK proof accordingly. Anyone can stake IOTX and obtain permission to run a prover.
-- Data availability: data availability refers to a storage which ensures the lifecycle persist of messages and tasks. It could be a database, a file system, a blockchain or a decentralized storage system, which implements the predefined interface.
+- Data availability: data availability refers to a storage which ensures the life cycle persist of messages and tasks. It could be a database, a file system, a blockchain or a decentralized storage system, which implements the predefined interface.
 - P2P network: In W3bstream, all sequencers and provers interact with each other over the P2P network, including dispatching, receiving, and reporting task status. To participate the processing of a project, a node needs to join the project topic and then process the information related to the project.
 - IPFS: Project config data is stored on IPFS. Users who want to publish a new project can use [ioctl](https://docs.iotex.io/the-iotex-stack/reference/ioctl-cli-reference) to push the project config file to IPFS.
 - Chain contract: Projects and provers are registered in IoTeX contracts. They are publicly available and open to all to register.

docs/BUILD-CIRCUIT.md

@@ -73,9 +73,9 @@ Or you can run `ioctl ws project config -t "halo2" -i "halo2_wasm_bg.wasm" -o "p
 ### Convert risc0 circuit to w3bstream project config
 
 ```bash
-ioctl ws project config -t "risc0" -i "methods.rs" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}
+ioctl ws project config -t "risc0" -i "methods.rs" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}"
 # if you need set datasource, you should add -s 
-ioctl ws project config -s "postgres://test_user:test_passwd@localhost:5432/test?sslmode=disable" -t "risc0" -i "methods.rs" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}
+ioctl ws project config -s "postgres://test_user:test_passwd@localhost:5432/test?sslmode=disable" -t "risc0" -i "methods.rs" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}"
 ```
 The values of `image_id` and `elf` are variable names, and will be found in the `methods.rs`.
 

docs/CONTRIBUTING.md

@@ -11,7 +11,7 @@ There are many ways to contribute to this project:
 1. **Code Contributions**: If you're looking to add or fix something in the codebase, please follow the steps outlined in the Getting started below.
 2. **Bug Reports**: If you find a bug, please open an issue using the **Bug Report** template..
 3. **Feature Suggestions**: Have ideas for new features? Open an issue using the **Feature Request** template.
-4. **Documentation**: Improvements or additions to our documentation are always welcome. We currently use GitBook for our documentation, and you can read it at [docs.iotex.io](https://docs.iotex.io). Just locat the "Edit this Page on GitHub" link on any page to start contributing.
+4. **Documentation**: Improvements or additions to our documentation are always welcome. We currently use GitBook for our documentation, and you can read it at [docs.iotex.io](https://docs.iotex.io). Just locate the "Edit this Page on GitHub" link on any page to start contributing.
 
 ## Getting Started
 

docs/DEVELOPER_GUIDE.md

@@ -92,7 +92,7 @@ Generate the W3bstream project:
 
 ```bash
 # Customize the output project file name "$ID" with a unique number
-ioctl ws project config -t "zkwasm" -i "zkwasm_demo.wasm" -o "path/ID""
+ioctl ws project config -t "zkwasm" -i "zkwasm_demo.wasm" -o "path/ID"
 ```
 
 #### Create a W3bstream Project Using RISC0
@@ -129,7 +129,7 @@ warning: methods_path is: "sprout/examples/risc0-circuits/target/release/build/r
 Generate the W3bstream Project
 
 ```bash
-ioctl ws project config -t "risc0" -i "methods.rs" -o "path/filename.json" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}
+ioctl ws project config -t "risc0" -i "methods.rs" -o "path/filename.json" -e "{\"image_id\":\"RANGE_ID\", \"elf\":\"RANGE_ELF\"}"
 ```
 
 The values of `image_id` and `elf` are variable names, and will be found in the `methods.rs` file.

docs/RUN-LOCALLY.md

@@ -21,9 +21,9 @@ docker compose version
 
 ## Create project config file
 after [build circuit](BUILD-CIRCUIT.md)
-- move `risc0-config.json` to `test/project, and then rename `risc0-config.json` to `20000`(`20000` is project id).  
-- move `halo2-config.json` to `test/project, and then rename `halo2-config.json` to `20001`(`20001` is project id).
-- move `zkwasm-config.json` to `test/project, and then rename `zkwasm-config.json` to `20002`(`20002` is project id).
+- move `risc0-config.json` to `test/project`, and then rename `risc0-config.json` to `20000` (`20000` is the project id).
+- move `halo2-config.json` to `test/project`, and then rename `halo2-config.json` to `20001` (`20001` is the project id).
+- move `zkwasm-config.json` to `test/project`, and then rename `zkwasm-config.json` to `20002` (`20002` is the project id).
 
 ## Configure W3bstream
 
@@ -41,7 +41,7 @@ export PRIVATE_KEY=${your private key}
 export BONSAI_KEY=${your bonsai key}
 ```
 
-3. Docker Compose will mount the current work directory under the `/data` volume. You can edit the file `docker-compose.yaml` to set `PROJECT_FILE_DIRECTORY` tp the appropriate path where the project configuration file (which includes the prover code) is stored.
+3. Docker Compose will mount the current work directory under the `/data` volume. You can edit the file `docker-compose.yaml` to set `PROJECT_FILE_DIRECTORY` to the appropriate path where the project configuration file (which includes the prover code) is stored.
 
 ## Running W3bstream
 
@@ -77,7 +77,7 @@ docker-compose down
 
 ## Send testing data to the W3bstream instance
 
-W3bstream projects are currently placed inside the folder `test/project`. Each project file name is a unique ID for the project. And each project file is composed of a JSON object definition that includes the binary code of the proover, vm type, and other parameters.
+W3bstream projects are currently placed inside the folder `test/project`. Each project file name is a unique ID for the project. And each project file is composed of a JSON object definition that includes the binary code of the prover, vm type, and other parameters.
 
 The following example sends a message to an example project deployed on the W3bstream instance that makes use of a RISC0 prover, which has project ID 20000, please change the project ID to yours if necessary: