Skip to content

Commit

Permalink
hotfix(docs): fix broken section links (#1230)
Browse files Browse the repository at this point in the history
  • Loading branch information
IAvecilla authored Oct 12, 2024
1 parent d1e9be4 commit 7679154
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 81 deletions.
2 changes: 1 addition & 1 deletion docs/1_introduction/0_about_aligned.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Aligned is a decentralized network that verifies Zero-Knowledge/validity proofs and posts the results to Ethereum. It is designed to provide high throughput, cheap proof verification with low latency.

{% hint style="info" %}
If you are unfamiliar with ZK and why this is useful, see [Why ZK and Aligned?](./5_why_zk.md)
If you are unfamiliar with ZK and why this is useful, see [Why ZK and Aligned?](./4_why_zk.md)
{% endhint %}

## Mission
Expand Down
File renamed without changes.
63 changes: 0 additions & 63 deletions docs/1_introduction/2_zkquiz.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Verifiable computation allows developers to build applications that help Ethereu

### What are the use cases for Aligned?

We believe that there are many things that will be built using Aligned that we have not even imagined yet. For some possible use cases please see [this page](../1_introduction/3_use_cases.md).
We believe that there are many things that will be built using Aligned that we have not even imagined yet. For some possible use cases please see [this page](../1_introduction/2_use_cases.md).

### Why don’t you run Aligned on top of a virtual machine?

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/3_guides/0_submitting_proofs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Submitting Proofs

Make sure you have Aligned installed as specified [here](../1_introduction/1_getting_started.md#Quickstart).
Make sure you have Aligned installed as specified [here](../1_introduction/1_try_aligned.md#quickstart).

If you run the examples below, make sure you are in Aligned's repository root.

Expand Down Expand Up @@ -100,7 +100,7 @@ These commands allow the usage of the following flags:

## 3. Submit your proof to the batcher

This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [First Aligned Application tutorial](../3_guides/2_build_your_first_aligned_application.md#app) where we explain how a program to generates a submit a proof looks like using the Aligned SDK.
This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [First Aligned Application tutorial](../3_guides/2_build_your_first_aligned_application.md#app) where we explain how to generate and submit a proof using the Aligned SDK.

Proof submission is done via the `submit` command of the Aligned CLI. The arguments for the submit command are:

Expand Down
6 changes: 4 additions & 2 deletions docs/3_guides/1_SDK_how_to.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ fn main() {

Or you can make a more complex call to submit a proof:

(code extract from [ZKQuiz](../1_introduction/2_zkquiz.md))
(code extract from [ZKQuiz example](../3_guides/2_build_your_first_aligned_application.md#app))

```rust
const BATCHER_URL: &str = "wss://batcher.alignedlayer.com";
Expand All @@ -67,7 +67,9 @@ fn main() {
let wallet = LocalWallet::decrypt_keystore(args.keystore_path, &keystore_password)
.expect("Failed to decrypt keystore")
.with_chain_id(17000u64);
let max_fee: U256 = estimate_fee(&rpc_url, PriceEstimate::Default).await.unwrap();
let max_fee = estimate_fee(&rpc_url, PriceEstimate::Instant)
.await
.expect("failed to fetch gas price from the blockchain");

// Call to SDK:
match submit_and_wait_verification(
Expand Down
8 changes: 1 addition & 7 deletions docs/3_guides/2_build_your_first_aligned_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,17 +147,11 @@ It is not mandatory to create an Smart Contract. You can make off-chain apps tha
**Program Identifier Validation**

The contract first checks that the commitment of the program matches with the one that we expect.

In our zkquiz example, we get the following elf_commitment:
In our zkquiz example, we get the following elf commitment:

```solidity
// contracts/src/VerifierContract.sol
bytes32 public elfCommitment = 0x3f99615fdf3b67a01e41b38eee75a32c778ee2fa631bd74e01c89afc2f70f5de;
if (elfCommitment != provingSystemAuxDataCommitment) {
revert InvalidElf(provingSystemAuxDataCommitment);
}
```

You can generate the expected commitment without actually generating and submitting a proof using the Aligned CLI tool running:
Expand Down
4 changes: 2 additions & 2 deletions docs/3_guides/4_generating_proofs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide assumes that:
- sp1 prover installed (instructions [here](https://succinctlabs.github.io/sp1/getting-started/install.html))
- sp1 project to generate the proofs
(instructions [here](https://succinctlabs.github.io/sp1/generating-proofs/setup.html))
- aligned installed (instructions [here](../1_introduction/1_getting_started.md#quickstart))
- aligned installed (instructions [here](../1_introduction/1_try_aligned.md#quickstart))

### How to generate a proof

Expand Down Expand Up @@ -106,7 +106,7 @@ This guide assumes that:

- Risc0 toolchain installed (instructions [here](https://dev.risczero.com/api/zkvm/quickstart#1-install-the-risc-zero-toolchain))
- Risc0 project to generate the proofs (instructions [here](https://dev.risczero.com/api/zkvm/quickstart#2-create-a-new-project))
- Aligned installed (instructions [here](../1_introduction/1_getting_started.md#quickstart))
- Aligned installed (instructions [here](../1_introduction/1_try_aligned.md#quickstart))

### How to generate a proof

Expand Down
6 changes: 3 additions & 3 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

* [About Aligned](1_introduction/0_about_aligned.md)
* [Try Aligned](1_introduction/1_try_aligned.md)
* [Use cases](1_introduction/3_use_cases.md)
* [FAQ](1_introduction/4_faq.md)
* [Why ZK and Aligned?](1_introduction/5_why_zk.md)
* [Use cases](1_introduction/2_use_cases.md)
* [FAQ](1_introduction/3_faq.md)
* [Why ZK and Aligned?](1_introduction/4_why_zk.md)

## Architecture

Expand Down

0 comments on commit 7679154

Please sign in to comment.