From 59b5e2657fa4d1630fd71f3f5a96668cc42ce3ab Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 19 Oct 2024 05:57:30 +0300 Subject: [PATCH] docs fix spelling issues (#709) * Update CONTRIBUTING.md * Update glossary.md * Update README.md * Update README.md --- README.md | 2 +- book/src/CONTRIBUTING.md | 2 +- book/src/glossary.md | 2 +- build/README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 10545e32d..4659b08da 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ see the [SDK section of the book](https://anton-rs.github.io/kona/sdk/intro.html **`client` / `host` SDK** -- [`common`](./crates/common): A suite of utilities for developing `client` programs to be ran on top of Fault Proof VMs. +- [`common`](./crates/common): A suite of utilities for developing `client` programs to be run on top of Fault Proof VMs. - [`common-proc`](./crates/common-proc): Proc macro for the `client` program entrypoint. - [`primitives`](./crates/primitives): Primitive types for use in `kona` crates. - [`preimage`](./crates/preimage): High level interfaces to the [`PreimageOracle`][fpp-specs] ABI diff --git a/book/src/CONTRIBUTING.md b/book/src/CONTRIBUTING.md index 563d511ab..d522cc9ef 100644 --- a/book/src/CONTRIBUTING.md +++ b/book/src/CONTRIBUTING.md @@ -23,7 +23,7 @@ Before working with this repository locally, you'll need to install several depe 1. Before anything, [create an issue](https://github.com/anton-rs/kona/issues/new) to discuss the change you're wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes. 1. Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can - be ran locally via the `justfile`s in the repository. + be run locally via the `justfile`s in the repository. 1. Make sure to update any documentation that has gone stale as a result of the change, in the `README` files, the [book][book], and in rustdoc comments. 1. Once you have sign-off from a maintainer, you may merge your pull request yourself if you have permissions to do so. diff --git a/book/src/glossary.md b/book/src/glossary.md index 8c1fe85dd..328c0b104 100644 --- a/book/src/glossary.md +++ b/book/src/glossary.md @@ -9,7 +9,7 @@ that is designed to execute verifiable programs. Full specification for the `cannon` & `cannon-rs` FPVMs, as an example, is available in the [Optimism Monorepo][cannon-specs]. #### Fault Proof Program -A `Fault Proof Program` is a program, commonly written in a general purpose language such as Golang, C, or Rust, that may be compiled down +A `Fault Proof Program` is a program, commonly written in a general-purpose language such as Golang, C, or Rust, that may be compiled down to a compatible `Fault Proof VM` target and provably executed on that target VM. Examples of `Fault Proof Programs` include the [OP Program][op-program], which runs on top of [`cannon`][cannon], [`cannon-rs`][cannon-rs], and diff --git a/build/README.md b/build/README.md index b9237be86..a8b70973b 100644 --- a/build/README.md +++ b/build/README.md @@ -1,6 +1,6 @@ # `kona-build` -This directory contains the cross compilation docker images and custom `rustc` targets used to build verifiable programs targeting various FPVMs. +This directory contains the cross-compilation docker images and custom `rustc` targets used to build verifiable programs targeting various FPVMs. ## Usage