Skip to content

Commit 7679154

Browse files
authored
hotfix(docs): fix broken section links (#1230)
1 parent d1e9be4 commit 7679154

File tree

10 files changed

+14
-81
lines changed

10 files changed

+14
-81
lines changed

docs/1_introduction/0_about_aligned.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
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.
44

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

99
## Mission
File renamed without changes.

docs/1_introduction/2_zkquiz.md

Lines changed: 0 additions & 63 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Verifiable computation allows developers to build applications that help Ethereu
166166

167167
### What are the use cases for Aligned?
168168

169-
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).
169+
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).
170170

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

File renamed without changes.

docs/3_guides/0_submitting_proofs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Submitting Proofs
22

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

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

@@ -100,7 +100,7 @@ These commands allow the usage of the following flags:
100100

101101
## 3. Submit your proof to the batcher
102102

103-
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.
103+
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.
104104

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

docs/3_guides/1_SDK_how_to.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ fn main() {
4747

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

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

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

7274
// Call to SDK:
7375
match submit_and_wait_verification(

docs/3_guides/2_build_your_first_aligned_application.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,17 +147,11 @@ It is not mandatory to create an Smart Contract. You can make off-chain apps tha
147147
**Program Identifier Validation**
148148

149149
The contract first checks that the commitment of the program matches with the one that we expect.
150-
151-
In our zkquiz example, we get the following elf_commitment:
150+
In our zkquiz example, we get the following elf commitment:
152151

153152
```solidity
154153
// contracts/src/VerifierContract.sol
155-
156154
bytes32 public elfCommitment = 0x3f99615fdf3b67a01e41b38eee75a32c778ee2fa631bd74e01c89afc2f70f5de;
157-
158-
if (elfCommitment != provingSystemAuxDataCommitment) {
159-
revert InvalidElf(provingSystemAuxDataCommitment);
160-
}
161155
```
162156

163157
You can generate the expected commitment without actually generating and submitting a proof using the Aligned CLI tool running:

docs/3_guides/4_generating_proofs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This guide assumes that:
99
- sp1 prover installed (instructions [here](https://succinctlabs.github.io/sp1/getting-started/install.html))
1010
- sp1 project to generate the proofs
1111
(instructions [here](https://succinctlabs.github.io/sp1/generating-proofs/setup.html))
12-
- aligned installed (instructions [here](../1_introduction/1_getting_started.md#quickstart))
12+
- aligned installed (instructions [here](../1_introduction/1_try_aligned.md#quickstart))
1313

1414
### How to generate a proof
1515

@@ -106,7 +106,7 @@ This guide assumes that:
106106

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

111111
### How to generate a proof
112112

docs/SUMMARY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
* [About Aligned](1_introduction/0_about_aligned.md)
66
* [Try Aligned](1_introduction/1_try_aligned.md)
7-
* [Use cases](1_introduction/3_use_cases.md)
8-
* [FAQ](1_introduction/4_faq.md)
9-
* [Why ZK and Aligned?](1_introduction/5_why_zk.md)
7+
* [Use cases](1_introduction/2_use_cases.md)
8+
* [FAQ](1_introduction/3_faq.md)
9+
* [Why ZK and Aligned?](1_introduction/4_why_zk.md)
1010

1111
## Architecture
1212

0 commit comments

Comments
 (0)