adjust doc links

succinctlabs · Feb 10, 2025 · c0486d0 · c0486d0
1 parent 6a921fb
commit c0486d0
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 SP1 is the fastest, most-feature complete zero-knowledge virtual machine (zkVM) that can prove the execution of arbitrary Rust (or any LLVM-compiled language) programs. SP1 makes ZK accessible to *any developer*, by making it easy to write ZKP programs in normal Rust code.
 
-**[Install](https://docs.succinct.xyz/docs/getting-started/install)**
+**[Install](https://docs.succinct.xyz/docs/sp1/getting-started/install)**
 | [Docs](https://succinctlabs.github.io/sp1)
 | [Examples](https://github.com/succinctlabs/sp1/tree/main/examples)
 | [Telegram Chat](https://t.me/+AzG4ws-kD24yMGYx)
@@ -13,7 +13,7 @@ SP1 is the fastest, most-feature complete zero-knowledge virtual machine (zkVM)
 
 Today, developers can write programs, including complex, large programs like a ZK Tendermint light client or type-1 zkEVM using Reth, in Rust (with std support), generate proofs and verify them. Most Rust crates should be supported and can be used seamlessly by your program. Example programs can be found in the [examples](https://github.com/succinctlabs/sp1/tree/main/examples) folder.
 
-To get started, make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. Then follow the [installation](https://docs.succinct.xyz/docs/getting-started/install) guide in the SP1 book and read the [getting started](https://docs.succinct.xyz/docs/getting-started/quickstart) section.
+To get started, make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. Then follow the [installation](https://docs.succinct.xyz/docs/sp1/getting-started/install) guide in the SP1 book and read the [getting started](https://docs.succinct.xyz/docs/sp1/getting-started/quickstart) section.
 
 ## Security
 

diff --git a/book/docs/verification/onchain/solidity-sdk.md b/book/docs/verification/onchain/solidity-sdk.md
@@ -37,7 +37,7 @@ contract Fibonacci {
     /// @dev This can either be a specific SP1Verifier for a specific version, or the
     ///      SP1VerifierGateway which can be used to verify proofs for any version of SP1.
     ///      For the list of supported verifiers on each chain, see:
-    ///      https://docs.succinct.xyz/onchain-verification/contract-addresses
+    ///      https://docs.succinct.xyz/docs/sp1/verification/onchain/contract-addresses
     address public verifier;
 
     /// @notice The verification key for the fibonacci program.

diff --git a/book/verification/onchain/solidity-sdk.md b/book/verification/onchain/solidity-sdk.md
@@ -37,7 +37,7 @@ contract Fibonacci {
     /// @dev This can either be a specific SP1Verifier for a specific version, or the
     ///      SP1VerifierGateway which can be used to verify proofs for any version of SP1.
     ///      For the list of supported verifiers on each chain, see:
-    ///      https://docs.succinct.xyz/onchain-verification/contract-addresses
+    ///      https://docs.succinct.xyz/docs/sp1/verification/onchain/contract-addresses
     address public verifier;
 
     /// @notice The verification key for the fibonacci program.

diff --git a/crates/core/executor/src/syscalls/write.rs b/crates/core/executor/src/syscalls/write.rs
@@ -102,7 +102,7 @@ impl Syscall for WriteSyscall {
                 panic!(
                     "You are using reserved file descriptor {fd} that is not supported on SP1 versions >= v4.0.0. \
                     Update your patches to the latest versions that are compatible with versions >= v4.0.0. \
-                    See `https://docs.succinct.xyz/docs/writing-programs/patched-crates` for more information"
+                    See `https://docs.succinct.xyz/docs/sp1/writing-programs/patched-crates` for more information"
                 );
             }
         } else if fd == FD_PUBLIC_VALUES {

diff --git a/crates/prover/src/lib.rs b/crates/prover/src/lib.rs
@@ -1271,7 +1271,7 @@ impl<C: SP1ProverComponents> SP1Prover<C> {
     fn check_for_high_cycles(cycles: u64) {
         if cycles > 100_000_000 {
             tracing::warn!(
-                "High cycle count detected ({}M cycles). For better performance, consider using the Succinct Prover Network: https://docs.succinct.xyz/generating-proofs/prover-network",
+                "High cycle count detected ({}M cycles). For better performance, consider using the Succinct Prover Network: https://docs.succinct.xyz/docs/sp1/generating-proofs/prover-network",
                 cycles / 1_000_000
             );
         }

diff --git a/crates/sdk/src/lib.rs b/crates/sdk/src/lib.rs
@@ -2,7 +2,7 @@
 //!
 //! A library for interacting with the SP1 RISC-V zkVM.
 //!
-//! Visit the [Getting Started](https://docs.succinct.xyz/docs/getting-started/install) section
+//! Visit the [Getting Started](https://docs.succinct.xyz/docs/sp1/getting-started/install) section
 //! in the official SP1 documentation for a quick start guide.
 
 #![warn(clippy::pedantic)]