From 88357b8e153aba97f766031a0cbad08ce4a50e63 Mon Sep 17 00:00:00 2001 From: EmilLuta Date: Mon, 18 Nov 2024 17:14:08 +0100 Subject: [PATCH] docs: Update prover docs links (#3302) --- prover/docs/src/00_intro.md | 26 +++++++++++++------------- prover/docs/src/02_setup.md | 2 +- prover/docs/src/05_proving_batch.md | 2 +- prover/docs/src/99_further_reading.md | 4 ++-- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/prover/docs/src/00_intro.md b/prover/docs/src/00_intro.md index fb79cf5bed0e..cae59ae1a28f 100644 --- a/prover/docs/src/00_intro.md +++ b/prover/docs/src/00_intro.md @@ -30,19 +30,19 @@ prover subsystem as well. We'll cover how the components work further in documentation. -[pg]: ../crates/bin/prover_fri_gateway/ -[wg]: ../crates/bin/witness_generator/ -[wvg]: ../crates/bin/witness_vector_generator/ -[p]: ../crates/bin/prover_fri/ -[pc]: ../crates/bin/proof_fri_compressor/ -[pdh]: ../../core/node/proof_data_handler/ -[hk]: ../../core/node/house_keeper/ -[vkg]: ../crates/bin/prover_cli/ -[pcli]: ../crates/bin/vk_setup_data_generator_server_fri/ -[mc]: ../../core/node/metadata_calculator/ -[cg]: ../../core/node/commitment_generator/ -[bwip]: ../../core/node/vm_runner/src/impls/bwip.rs -[prw]: ../../core/node/vm_runner/src/impls/protective_reads.rs +[pg]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/prover_fri_gateway +[wg]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/witness_generator +[wvg]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/witness_vector_generator +[p]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/prover_fri +[pc]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/proof_fri_compressor +[pdh]: https://github.com/matter-labs/zksync-era/tree/main/core/node/proof_data_handler +[hk]: https://github.com/matter-labs/zksync-era/tree/main/core/node/house_keeper +[vkg]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/vk_setup_data_generator_server_fri +[pcli]: https://github.com/matter-labs/zksync-era/tree/main/prover/crates/bin/prover_cli +[mc]: https://github.com/matter-labs/zksync-era/tree/main/core/node/metadata_calculator +[cg]: https://github.com/matter-labs/zksync-era/tree/main/core/node/commitment_generator +[bwip]: https://github.com/matter-labs/zksync-era/blob/main/core/node/vm_runner/src/impls/bwip.rs +[prw]: https://github.com/matter-labs/zksync-era/blob/main/core/node/vm_runner/src/impls/protective_reads.rs ## How it runs diff --git a/prover/docs/src/02_setup.md b/prover/docs/src/02_setup.md index 67c2b0b945ff..615a71be291c 100644 --- a/prover/docs/src/02_setup.md +++ b/prover/docs/src/02_setup.md @@ -6,7 +6,7 @@ machine in place, e.g. a compatible local machine or a prepared GCP VM. ## ZKsync repo setup If you haven't already, you need to initialize the ZKsync repository first. Follow -[this guide](../../docs/guides/setup-dev.md) for that. +[this guide](https://matter-labs.github.io/zksync-era/core/latest/guides/setup-dev.html) for that. Before proceeding, make sure that you can run the server and integration tests pass. diff --git a/prover/docs/src/05_proving_batch.md b/prover/docs/src/05_proving_batch.md index c35de975bf71..6bcf57a06a40 100644 --- a/prover/docs/src/05_proving_batch.md +++ b/prover/docs/src/05_proving_batch.md @@ -18,7 +18,7 @@ First of all, you need to install CUDA drivers, all other things will be dealt w For that, check the following [guide](./02_setup.md)(you can skip bellman-cuda step). Install the prerequisites, which you can find -[here](https://github.com/matter-labs/zksync-era/blob/main/docs/guides/setup-dev.md). Note, that if you are not using +[here](https://matter-labs.github.io/zksync-era/core/latest/guides/setup-dev.html). Note, that if you are not using Google VM instance, you also need to install [gcloud](https://cloud.google.com/sdk/docs/install#deb). Now, you can use `zkstack` and `prover_cli` tools for setting up the env and running prover subsystem. diff --git a/prover/docs/src/99_further_reading.md b/prover/docs/src/99_further_reading.md index 7b916167dbdd..98a2d6b4337f 100644 --- a/prover/docs/src/99_further_reading.md +++ b/prover/docs/src/99_further_reading.md @@ -9,6 +9,6 @@ However, we have some documentation that is more focused on theory of proving in You may find the following articles helpful for general understanding of ZK proofs: - [ZK intuition](https://matter-labs.github.io/zksync-era/core/latest/guides/advanced/13_zk_intuition.html). -- [ZK deeper overview](https://matter-labs.github.io/zksync-era/core/latest/docs/guides/advanced/14_zk_deeper_overview.html). -- [Prover keys](https://matter-labs.github.io/zksync-era/core/latest/docs/guides/advanced/15_prover_keys.html). +- [ZK deeper overview](https://matter-labs.github.io/zksync-era/core/latest/guides/advanced/14_zk_deeper_overview.html). +- [Prover keys](https://matter-labs.github.io/zksync-era/core/latest/guides/advanced/15_prover_keys.html). - [Overview of our ZK proving system implementation](https://matter-labs.github.io/zksync-era/core/latest/specs/prover/overview.html).