Skip to content

Commit 2661d68

Browse files
authored
docs: fix missing broken links from dir rename (#927)
1 parent 323a191 commit 2661d68

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

docs/1_introduction/1_getting_started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started!
22

3-
In this tutorial you will learn how to send your first SP1 proofs to get verified in Aligned in under 3 minutes.
3+
In this tutorial, you will learn how to send your first SP1 proofs to get verified in Aligned in under 3 minutes.
44

55
## Quickstart
66
We will download a previously generated SP1 proof, send it to Aligned for verification, and retrieve the results from Ethereum Holesky testnet.
@@ -54,24 +54,24 @@ aligned verify-proof-onchain \
5454
--chain holesky
5555
```
5656
57-
This is reading the result of the verification of the proof in Ethereum.
57+
This is reading the result of the proof verification in Ethereum.
5858
5959
7. You should get this result:
6060
6161
```bash
6262
[2024-06-17T21:58:43Z INFO aligned] Your proof was verified in Aligned and included in the batch!
6363
```
6464
65-
If the proof wasn't verified you should get this result:
65+
If the proof wasn't verified, you should get this result:
6666
6767
```bash
6868
[2024-06-17T21:59:09Z INFO aligned] Your proof was not included in the batch.
6969
```
7070
7171
Aligned works in:
72-
- MacOS Arm64 (M1 or higher)
72+
- macOS Arm64 (M1 or higher)
7373
- Linux x86 with GLIBC_2.32 or superior (For example, Ubuntu 22.04 or higher)
7474
7575
If you don't meet these requirements, you can compile the binaries yourself following the [README](https://github.com/yetanotherco/aligned_layer)
7676
77-
To try Aligned with other proving systems, check [this](https://docs.alignedlayer.com/guides/0_submitting_proofs) guide
77+
To try Aligned with other proving systems, check [this](../3_guides/0_submitting_proofs) guide

docs/3_guides/0_submitting_proofs.md

Lines changed: 3 additions & 3 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](../introduction/1_getting_started.md#Quickstart).
3+
Make sure you have Aligned installed as specified [here](../1_introduction/1_getting_started.md#Quickstart).
44

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

@@ -15,7 +15,7 @@ The following is the list of the verifiers currently supported by Aligned:
1515
- :white_check_mark: Halo2 - Plonk/KZG
1616
- :white_check_mark: Halo2 - Plonk/IPA
1717

18-
Learn more about future verifiers [here](../architecture/0_supported_verifiers.md).
18+
Learn more about future verifiers [here](../2_architecture/0_supported_verifiers.md).
1919

2020
## 1. Import/Create Keystore file
2121

@@ -99,7 +99,7 @@ These commands allow the usage of the following flags:
9999

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

102-
This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [Aligned SDK guide](../guides/1_SDK.md).
102+
This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [Aligned SDK guide](../3_guides/2_integrating_aligned_into_your_application.md).
103103

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

docs/3_guides/4_generating_proofs.md

Lines changed: 7 additions & 7 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](../introduction/1_getting_started.md#quickstart))
12+
- aligned installed (instructions [here](../1_introduction/1_getting_started.md#quickstart))
1313

1414
### How to generate a proof
1515

@@ -47,7 +47,7 @@ aligned submit \
4747

4848
Where `proof_path` is the path to the proof file, `vm_program_path` is the path to the ELF file. `proof_generator_addr` is an optional parameter that works as a helper for some applications where you can be frontrunned.
4949

50-
For more instructions on how to submit proofs, check the [Submitting proofs guide](../guides/0_submitting_proofs.md).
50+
For more instructions on how to submit proofs, check the [Submitting proofs guide](../3_guides/0_submitting_proofs.md).
5151

5252
## Gnark
5353

@@ -98,7 +98,7 @@ aligned submit \
9898
Where proof path is the path to the proof file, `public_input_path` is the path to the public input file,
9999
and `verification_key_path` is the path to the verification key file.
100100

101-
For more instructions on how to submit proofs, check the [Submitting proofs guide](../guides/0_submitting_proofs.md).
101+
For more instructions on how to submit proofs, check the [Submitting proofs guide](../3_guides/0_submitting_proofs.md).
102102

103103
## Risc0
104104

@@ -108,7 +108,7 @@ This guide assumes that:
108108

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

113113
### How to generate a proof
114114

@@ -174,7 +174,7 @@ aligned submit \
174174
--payment_service_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
175175
```
176176

177-
For more instructions on how to submit proofs, check the [Submitting proofs guide](../guides/0_submitting_proofs.md).
177+
For more instructions on how to submit proofs, check the [Submitting proofs guide](../3_guides/0_submitting_proofs.md).
178178

179179
## Halo2
180180

@@ -184,7 +184,7 @@ This guide assumes that:
184184

185185
- You are using PSE fork of the Halo2 [proof system](https://github.com/privacy-scaling-explorations/halo2).
186186
- You have a strong understanding of Halo2 circuit development and are familiar with the Halo2 proof system.
187-
- Aligned installed (instructions [here](../introduction/1_getting_started.md#quickstart)).
187+
- Aligned installed (instructions [here](../1_introduction/1_getting_started.md#quickstart)).
188188

189189
### Import the Halo2 fork library
190190

@@ -280,4 +280,4 @@ aligned submit \
280280
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
281281
```
282282

283-
For more instructions on how to submit proofs, check the [Submitting proofs guide](../guides/0_submitting_proofs.md).
283+
For more instructions on how to submit proofs, check the [Submitting proofs guide](../3_guides/0_submitting_proofs.md).

docs/3_guides/6_setup_aligned.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Note that when upgrading the contracts, you must also:
124124

125125
## Aggregator
126126

127-
To start the [Aggregator](../architecture/components/5_aggregator.md):
127+
To start the [Aggregator](../2_architecture/components/5_aggregator.md):
128128

129129
```bash
130130
make aggregator_start
@@ -143,7 +143,7 @@ make aggregator_start CONFIG_FILE=<path_to_config_file>
143143

144144
## Operator
145145

146-
To start an [Operator](../architecture/components/4_operator.md)
146+
To start an [Operator](../2_architecture/components/4_operator.md)
147147
(note it also registers it):
148148

149149
```bash
@@ -309,7 +309,7 @@ eigenlayer operator keys import --key-type bls <keystore-name> <private-key>
309309
310310
## Batcher
311311
312-
To start the [Batcher](../architecture/components/1_batcher.md):
312+
To start the [Batcher](../2_architecture/components/1_batcher.md):
313313
314314
```bash
315315
make batcher_start

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,4 @@
5353
* [Blog](https://mirror.xyz/0x7794D1c55568270A81D8Bf39e1bcE96BEaC10901)
5454
* [Website](https://alignedlayer.com)
5555
* [Github](https://github.com/yetanotherco/aligned_layer)
56+
* [YouTube](https://www.youtube.com/@alignedlayer)

0 commit comments

Comments
 (0)