Skip to content

Commit

Permalink
docs fix spelling issues (#709)
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING.md

* Update glossary.md

* Update README.md

* Update README.md
  • Loading branch information
nnsW3 authored Oct 19, 2024
1 parent a53374c commit 59b5e26
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion book/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion book/src/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion build/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 59b5e26

Please sign in to comment.