Skip to content

Commit

Permalink
Ensure main-status check always runs (risc0#1114)
Browse files Browse the repository at this point in the history
* Fix doc job: install foundry toolchain
* Fix broken links
  • Loading branch information
flaub authored Nov 7, 2023
1 parent 1a6dafa commit 594b511
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ jobs:
# see: https://github.com/orgs/community/discussions/26822
main-status-check:
if: always()
needs:
- check
- check-benchmarks
Expand Down Expand Up @@ -223,6 +224,7 @@ jobs:
- run: "git checkout -f $(git -c user.name=x -c user.email=x@x commit-tree $(git hash-object -t tree /dev/null) < /dev/null) || :"
- uses: actions/checkout@v4
- uses: ./.github/actions/rustup
- uses: risc0/foundry-toolchain@2fe7e70b520f62368a0e3c464f997df07ede420f
- uses: ./.github/actions/sccache
with:
key: macOS-default
Expand Down
2 changes: 1 addition & 1 deletion website/api/bonsai/bonsai-on-eth.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ As an alternative to sending a `Callback request` from the REST API as described

#### Example

Using [cast]:
Using `cast`:

```bash
cast send --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d --gas-limit 100000 "$APP_ADDRESS" 'calculateFibonacci(uint256)' 5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ There are also a number of functions available to support with debugging and per
[`env::get_cycle_count`]: https://docs.rs/risc0-zkvm/0.18.0/risc0_zkvm/guest/env/fn.get_cycle_count.html
[`env::log`]: https://docs.rs/risc0-zkvm/0.18.0/risc0_zkvm/guest/env/fn.log.html

For more information on optimization & performance, see our pages on [Cryptography Acceleration](acceleration) and [Benchmarking](../benchmarks).
For more information on optimization & performance, see our pages on [Cryptography Acceleration](./acceleration.md) and [Benchmarking](../benchmarks.md).

## Boilerplate before `main()`

Expand Down
2 changes: 1 addition & 1 deletion website/api_versioned_docs/version-0.18/zkvm/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ cargo install cargo-risczero
cargo risczero install
```

If you need to install Rust or encounter problems, take a look at our [full installation instructions](install).
If you need to install Rust or encounter problems, take a look at our [full installation instructions](./install.md).

## 2. Initialize a New Project

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Read the [article](https://risczero.com/news/zeth-release).
[guest programs]: developer-guide/guest-code-101
[host]: /terminology#host-program
[host program]: developer-guide/host-code-101
[performance benchmarks]: benchmarks
[performance benchmarks]: ./benchmarks.md
[prove]: /terminology#validity-proof
[proofs]: /terminology#validity-proof
[prover]: /terminology#prover
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ As an alternative to sending a `Callback request` from the REST API as described

#### Example

Using [cast]:
Using `cast`:

```bash
cast send --private-key 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d --gas-limit 100000 "$APP_ADDRESS" 'calculateFibonacci(uint256)' 5
Expand Down
2 changes: 1 addition & 1 deletion website/docs/proof-system/proof-system-sequence-diagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ For a more formal articulation of the protocol, refer to the [ZKP Whitepaper].

### Extended Main Execution Trace

- The Prover runs a computation in order to generate an [`Execution Trace`](what_is_a_trace).
- The Prover runs a computation in order to generate an [`Execution Trace`](./what_is_a_trace.md).
- The `trace` is organized into `columns`, and the columns are categorized as `control columns`, `data columns`, and `auxiliary/accum columns`.
- The `control columns` handle system initialization and shutdown, the initial program code to load into memory before execution, and other control signals that don't depend on the program execution.
- The `data columns` contain the input and the computation data, both of which are private. These columns are committed in two orderings:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/proof-system/stark-by-hand.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The [proof system sequence diagram](proof-system-sequence-diagram.md) describes

## Lesson 1: The Execution Trace

> When any code executes in the RISC Zero virtual machine, each step of that execution is recorded in an [`Execution Trace`](what_is_a_trace.md).
> When any code executes in the RISC Zero virtual machine, each step of that execution is recorded in an [`Execution Trace`](./what_is_a_trace.md).
We show a simplified example, computing 4 steps of a Fibonacci sequence modulo 97, using two user-specified inputs.

Expand Down

0 comments on commit 594b511

Please sign in to comment.