chore: fix all deadlinks, path adjust script for versioning

succinctlabs · Dec 4, 2024 · b81b747 · b81b747
1 parent 3913da4
commit b81b747
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 8 deletions.
diff --git a/book/README.md b/book/README.md
@@ -32,3 +32,4 @@ This command generates static content into the `build` directory and can be serv
 - Code snippets from the repo are made through the [gen script](./gen-code-refs.sh).
     - When adding new code snippets, ensure that the gen script is updated to include the new file.
 - Check out the [Docusaurus documentation](https://docusaurus.io/docs/versioning) versioning information.
+    - You can use the [adjustment](./adjust-version-path.sh) script to adjust the import path in the markdown files after changing the version.
diff --git a/book/adjust-version-path.sh b/book/adjust-version-path.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+shopt -s globstar
+
+pushd "versioned_docs/version-$1"
+
+if [[ $OSTYPE == "darwin"* ]]; then
+    # Mac OS X
+    sed -i '' 's|\.\.\/\.\.\/static|..\/..\/..\/static|g' **/*.md
+    sed -i '' 's|\.\.\/\.\.\/static|..\/..\/..\/static|g' **/*.mdx
+else
+    # Other OSes
+    sed -i 's|\.\.\/\.\.\/static|..\/..\/..\/static|g' **/*.md
+    sed -i 's|\.\.\/\.\.\/static|..\/..\/..\/static|g' **/*.mdx
+fi
+
+popd
diff --git a/book/docs/generating-proofs/prover-network/usage.md b/book/docs/generating-proofs/prover-network/usage.md
@@ -19,8 +19,8 @@ SP1_PROVER=network SP1_PRIVATE_KEY=... RUST_LOG=info cargo run --release
 
 - `SP1_PROVER` should be set to `network` when using the prover network.
 
-- `SP1_PRIVATE_KEY` should be set to your [private key](../prover-network#key-setup). You will need
-  to be using a [whitelisted](../prover-network#get-access) key to use the network.
+- `SP1_PRIVATE_KEY` should be set to your [private key](./key-setup.md). You will need
+  to be using a [whitelisted](../prover-network) key to use the network.
 
 When you call any of the prove functions in ProverClient now, it will first simulate your program, then wait for it to be proven through the network and finally return the proof.
 

diff --git a/book/docs/verification/onchain/getting-started.mdx b/book/docs/verification/onchain/getting-started.mdx
@@ -8,7 +8,7 @@ The best way to get started with verifying SP1 proofs on-chain is to refer to th
 - The template [script](https://github.com/succinctlabs/sp1-project-template/blob/main/script/src/bin/prove.rs) shows how to generate the proof using the SDK and save it to a file.
 - The template [contract](https://github.com/succinctlabs/sp1-project-template/blob/main/contracts/src/Fibonacci.sol) shows how to verify the proof onchain using Solidity.
 
-Refer to the section on [Contract Addresses](./contract-addresses#contract-addresses) for the addresses of the deployed verifiers.
+Refer to the section on [Contract Addresses](./contract-addresses) for the addresses of the deployed verifiers.
 
 ## Generating SP1 Proofs for Onchain Verification
 

diff --git a/book/docs/writing-programs/compiling.mdx b/book/docs/writing-programs/compiling.mdx
@@ -8,7 +8,7 @@ Once you have written an SP1 program, you must compile it to an ELF file that ca
 
 > WARNING: This may not generate a reproducible ELF which is necessary for verifying that your binary corresponds to given source code.
 >
-> Use the [reproducible build system](#reproducible-builds-with-docker-production) for production builds.
+> Use the [reproducible build system](#production-builds) for production builds.
 
 To build a program while developing, simply run the following command in the crate that contains your SP1 program:
 

diff --git a/book/versioned_docs/version-3.4.0/generating-proofs/prover-network/usage.md b/book/versioned_docs/version-3.4.0/generating-proofs/prover-network/usage.md
@@ -19,8 +19,8 @@ SP1_PROVER=network SP1_PRIVATE_KEY=... RUST_LOG=info cargo run --release
 
 - `SP1_PROVER` should be set to `network` when using the prover network.
 
-- `SP1_PRIVATE_KEY` should be set to your [private key](../prover-network#key-setup). You will need
-  to be using a [whitelisted](../prover-network#get-access) key to use the network.
+- `SP1_PRIVATE_KEY` should be set to your [private key](./key-setup.md). You will need
+  to be using a [whitelisted](../prover-network) key to use the network.
 
 When you call any of the prove functions in ProverClient now, it will first simulate your program, then wait for it to be proven through the network and finally return the proof.
 

diff --git a/book/versioned_docs/version-3.4.0/verification/onchain/getting-started.mdx b/book/versioned_docs/version-3.4.0/verification/onchain/getting-started.mdx
@@ -8,7 +8,7 @@ The best way to get started with verifying SP1 proofs on-chain is to refer to th
 - The template [script](https://github.com/succinctlabs/sp1-project-template/blob/main/script/src/bin/prove.rs) shows how to generate the proof using the SDK and save it to a file.
 - The template [contract](https://github.com/succinctlabs/sp1-project-template/blob/main/contracts/src/Fibonacci.sol) shows how to verify the proof onchain using Solidity.
 
-Refer to the section on [Contract Addresses](./contract-addresses#contract-addresses) for the addresses of the deployed verifiers.
+Refer to the section on [Contract Addresses](./contract-addresses) for the addresses of the deployed verifiers.
 
 ## Generating SP1 Proofs for Onchain Verification
 

diff --git a/book/versioned_docs/version-3.4.0/writing-programs/compiling.mdx b/book/versioned_docs/version-3.4.0/writing-programs/compiling.mdx
@@ -8,7 +8,7 @@ Once you have written an SP1 program, you must compile it to an ELF file that ca
 
 > WARNING: This may not generate a reproducible ELF which is necessary for verifying that your binary corresponds to given source code.
 >
-> Use the [reproducible build system](#reproducible-builds-with-docker-production) for production builds.
+> Use the [reproducible build system](#production-builds) for production builds.
 
 To build a program while developing, simply run the following command in the crate that contains your SP1 program: