Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix typos in documentation #1512

Merged
merged 9 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book/developers/usage-in-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

You may want to use SP1 in your [Github Actions](https://docs.github.com/en/actions) CI workflow.

You first need have Rust installed, and you can use
You first need to have Rust installed, and you can use
[actions-rs/toolchain](https://github.com/actions-rs/toolchain) for this:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion book/generating-proofs/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

All the methods you'll need for generating proofs are included in the `sp1_sdk` crate. Most importantly, you'll need to use the `ProverClient` to setup a proving key and verifying key for your program and then use the `execute`, `prove` and `verify` methods to execute your program, and generate and verify proofs.

To make this more concrete, let's walk through a simple example of generating a proof for a Fiboancci program inside the zkVM.
To make this more concrete, let's walk through a simple example of generating a proof for a Fibonacci program inside the zkVM.

## Example: Fibonacci

Expand Down
2 changes: 1 addition & 1 deletion book/generating-proofs/prover-network/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you submit a proof request to the prover network and you are not using a supp

## Changing versions

You must switch to a supported version before submitting a proof. To do so, replace the `sp1-zkvm` version in your progam's `Cargo.toml`:
You must switch to a supported version before submitting a proof. To do so, replace the `sp1-zkvm` version in your program's `Cargo.toml`:

```toml
[dependencies]
Expand Down
2 changes: 1 addition & 1 deletion book/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SP1 has undergone multiple audits from leading ZK security firms and is currentl

Zero-knowledge proofs (ZKPs) are one of the most critical technologies to blockchain scaling, interoperability and privacy. But, historically building ZKP systems was extrememly complicated--requiring large teams with specialized cryptography expertise and taking years to go to production.

SP1 provides a performant, general-purpose zkVM that enables **any developer** to use ZKPs by writing normal code (in Rust), and get cheap and fast proofs. SP1 will enable ZKPs to become mainstream, introducing a a new era of verifiability for all of blockchain infrastructure and beyond.
SP1 provides a performant, general-purpose zkVM that enables **any developer** to use ZKPs by writing normal code (in Rust), and get cheap and fast proofs. SP1 will enable ZKPs to become mainstream, introducing a new era of verifiability for all of blockchain infrastructure and beyond.


## SP1 enables a diversity of use-cases
Expand Down
2 changes: 1 addition & 1 deletion book/why-use-sp1.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ SP1 enables teams to use ZKPs in production with minimal overhead and fast timel

**Maintainable:** With SP1, you can reuse existing Rust crates, like `revm`, `reth`, `tendermint-rs`, `serde` and more, to write your ZKP logic in maintainable, Rust code.

**Go to market faster:** By reusing existng crates and expressing ZKP logic in regular code, SP1 significantly reduces audit surface area and complexity, enabling teams to go to market with ZKPs faster.
**Go to market faster:** By reusing existing crates and expressing ZKP logic in regular code, SP1 significantly reduces audit surface area and complexity, enabling teams to go to market with ZKPs faster.

## Blazing Fast Performance

Expand Down
4 changes: 2 additions & 2 deletions crates/recursion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Debugging recursion programs
The recursion programs are executed in the recursion runtime. In case of a panic in the recursion
runtime, rust will panic with a `TRAP` error. In order to get detailed information about the panic,
with a backtrace, compile the test with the evvironment variables:
with a backtrace, compile the test with the environment variables:
```bash
RUST_BACKTRACE=1 RUSTFLAGS="-g" SP1_DEBUG=true
```
```
2 changes: 1 addition & 1 deletion crates/zkvm/entrypoint/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- fix release-plz ([#1088](https://github.com/succinctlabs/sp1/pull/1088))
- add release-plz ([#1086](https://github.com/succinctlabs/sp1/pull/1086))
- _(deps)_ bump serde from 1.0.203 to 1.0.204 ([#1063](https://github.com/succinctlabs/sp1/pull/1063))
- clenaup zkvm
- cleanup zkvm
- hm
- cleanup zkvm/lib
- _(deps)_ bump lazy_static from 1.4.0 to 1.5.0
Expand Down