From 832fbf5da6fc522b115d6198450f0928192d52cf Mon Sep 17 00:00:00 2001 From: fakedev9999 Date: Tue, 21 Jan 2025 14:38:21 -0800 Subject: [PATCH] docs: fix link to range & aggregation program --- .github/workflows/book.yml | 8 -------- book.toml | 10 +++++----- book/architecture.md | 4 ++-- book/book.toml | 10 ---------- 4 files changed, 7 insertions(+), 25 deletions(-) delete mode 100644 book/book.toml diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index 9e68c8a1..1011b943 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -50,14 +50,6 @@ jobs: curl -sSL https://github.com/sgoudham/mdbook-template/releases/latest/download/mdbook-template-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook-template echo $(pwd)/mdbook-template >> $GITHUB_PATH - - name: Install mdbook-linkcheck - run: | - mkdir mdbook-linkcheck - curl -sSL -o mdbook-linkcheck.zip https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip - unzip mdbook-linkcheck.zip -d ./mdbook-linkcheck - chmod +x $(pwd)/mdbook-linkcheck/mdbook-linkcheck - echo $(pwd)/mdbook-linkcheck >> $GITHUB_PATH - - uses: Swatinem/rust-cache@v2 with: cache-on-failure: true diff --git a/book.toml b/book.toml index 6193b68e..8019f3ec 100644 --- a/book.toml +++ b/book.toml @@ -1,20 +1,20 @@ [book] -authors = ["Uma Roy"] +authors = ["Uma Roy", "ratankaliani"] language = "en" multilingual = false src = "book" -title = "OP Succinct" +title = "OP Succinct book" description = "A book on all things SP1" [build] build-dir = "target/book" +[output.html] +git-repository-url = "https://github.com/succinctlabs/op-succinct" + [preprocessor.template] before = ["links"] [preprocessor.index] [preprocessor.links] - -[output.linkcheck] -traverse-parent-directories = true diff --git a/book/architecture.md b/book/architecture.md index a7e390eb..1adeaf21 100644 --- a/book/architecture.md +++ b/book/architecture.md @@ -34,11 +34,11 @@ OP Succinct enables OP Stack blocks to be proven with SP1 through a lightweight ### Core Components -1. **[Range Program](../programs/range/src/main.rs)** +1. **[Range Program](https://github.com/succinctlabs/op-succinct/tree/main/programs/range/src/main.rs)** - Derives and executes batches of blocks - Generates proofs of correct execution -2. **[Aggregation Program](../programs/aggregation/src/main.rs)** +2. **[Aggregation Program](https://github.com/succinctlabs/op-succinct/tree/main/programs/aggregation/src/main.rs)** - Aggregates multiple range program proofs - Reduces on-chain verification costs diff --git a/book/book.toml b/book/book.toml deleted file mode 100644 index f4f9c9ca..00000000 --- a/book/book.toml +++ /dev/null @@ -1,10 +0,0 @@ -[book] -authors = ["ratankaliani"] -language = "en" -multilingual = false -title = "OP Succinct book" - -[output.html] -default-theme = "rust" -preferred-dark-theme = "rust" -git-repository-url = "https://github.com/succinctlabs/op-succinct"