[Docs]: Update docusaurus to latest and add versioned docs (#661)

Add versioned docs for 1.10.1, 2.8.0, and v3 versions

.github/workflows/deploy-docs.yml

@@ -25,7 +25,7 @@ jobs:
           cache-dependency-path: ./repo/docs/package-lock.json
 
       - name: Install dependencies
-        run: npm install --frozen-lockfile
+        run: npm install
         working-directory: ./repo/docs
 
       - name: Build website

.github/workflows/release.yml

@@ -49,21 +49,31 @@ jobs:
         run: |
           git config user.name release-bot
           git config user.email [email protected]
-          cargo workspaces version ${{ inputs.releaseType }} -y --no-individual-tags -m "Bump rust crates' version"
+          cargo workspaces version ${{ inputs.releaseType }} -y --no-individual-tags --no-git-push -m "Bump rust crates' version"
+      - name: Bump docs version
+        id: bump-docs-version
+        if: inputs.releaseType != 'patch'
+        working-directory: ./docs
+        run: |
+          LATEST_TAG=$(git describe --tags --abbrev=0)
+          LATEST_VERSION=$LATEST_TAG:0:1
+          npm run docusaurus docs:version $LATEST_VERSION
+          git add --all
+          git commit -m "Bump docs version"
+          git push
       - name: Create draft release
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |          
-          mkdir -p release_output && rm -rf ./release_output/*
-          # skip building release tar. TODO Yuval fix
-          # ./scripts/release/build_all.sh ./release_output
           LATEST_TAG=$(git describe --tags --abbrev=0)
           gh release create $LATEST_TAG --generate-notes -d --verify-tag -t "Release $LATEST_TAG"
       - name: Upload release tars
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
+          mkdir -p release_output && rm -rf ./release_output/*
           LATEST_TAG=$(git describe --tags --abbrev=0)
+          ./scripts/release/build_all.sh ./release_output $LATEST_TAG
           for file in ./release_output/*.tar.gz; do
             gh release upload $LATEST_TAG "$file"
           done

.github/workflows/test-deploy-docs.yml

@@ -22,7 +22,7 @@ jobs:
           cache-dependency-path: ./repo/docs/package-lock.json
 
       - name: Install dependencies
-        run: npm install --frozen-lockfile
+        run: npm install
         working-directory: ./repo/docs
       - name: Test build website
         run: npm run build

docs/.gitignore

@@ -2,6 +2,7 @@
 node_modules/
 yarn.lock
 .DS_Store
+build/
 
 # tex build artifacts
 .aux

docs/docs/icicle/colab-instructions.md

@@ -9,11 +9,11 @@ First thing to do in a notebook is to set the runtime type to a T4 GPU.
 
 - in the upper corner click on the dropdown menu and select "change runtime type"
 
-![Change runtime](../../static/img/colab_change_runtime.png)
+![Change runtime](./static/img/colab_change_runtime.png)
 
 - In the window select "T4 GPU" and press Save
 
-![T4 GPU](../../static/img/t4_gpu.png)
+![T4 GPU](./static/img/t4_gpu.png)
 
 Installing Rust is rather simple, just execute the following command:
 

docs/docs/icicle/golang-bindings.md

@@ -54,7 +54,7 @@ If more than one curve or more than one field is supplied, the last one supplied
 
 :::
 
-To build ICICLE libraries for all supported curves without certain features, you can use their -skip_<feature\> flags. For example, for disabling G2 and ECNTT:
+To build ICICLE libraries for all supported curves without certain features, you can use their -skip_\<feature> flags. For example, for disabling G2 and ECNTT:
 
 ```bash
 ./build.sh -curve=all -skip_g2 -skip_ecntt

docs/docs/icicle/integrations.md

@@ -10,7 +10,7 @@ If you're interested in understanding these integrations better or learning how
 
 Lets illustrate an ICICLE integration, so you can understand the core API and design overview of ICICLE.
 
-![ICICLE architecture](../../static/img/architecture-high-level.png)
+![ICICLE architecture](./static/img/architecture-high-level.png)
 
 Engineers usually use a cryptographic library to implement their ZK protocols. These libraries implement efficient primitives which are used as building blocks for the protocol; ICICLE is such a library. The difference is that ICICLE is designed from the start to run on GPUs; the Rust and Golang APIs abstract away all low level CUDA details. Our goal was to allow developers with no GPU experience to quickly get started with ICICLE.
 

docs/docs/icicle/overview.md

@@ -9,11 +9,8 @@ title: ICICLE Overview
   <img src="https://github.com/user-attachments/assets/02080cc6-9761-4764-8ae4-05778cc93cfa" alt="Untitled design (29)" width="500"/>
 </p>
 
-
-
 ## What is ICICLE?
 
-
 [![GitHub Release](https://img.shields.io/github/v/release/ingonyama-zk/icicle)](https://github.com/ingonyama-zk/icicle/releases)
 
 [ICICLE](https://github.com/ingonyama-zk/icicle) is a cryptography library designed to accelerate zero-knowledge proofs (ZKPs) using multiple compute backends, including GPUs, CPUs, and potentially other platforms. ICICLE's key strength lies in its ability to implement blazing-fast cryptographic primitives, enabling developers to significantly reduce proving times with minimal effort.
@@ -78,7 +75,10 @@ ICICLE is also well-suited for prototyping and developing small-scale projects.
 
 Explore the full capabilities of ICICLE by diving into the [Architecture](./arch_overview.md), [Getting Started Guide](./getting_started.md) and the [Programmer's Guide](./programmers_guide/general.md) to learn how to integrate, deploy, and extend ICICLE across different backends.
 
-If you have any questions or need support, feel free to reach out on [Discord], [GitHub](https://github.com/ingonyama-zk) or <support@ingonyama.com>. We're here to help you accelerate your ZK development with ICICLE.
+If you have any questions or need support, feel free to reach out on [Discord], [GitHub] or [via support email][SupportEmail]. We're here to help you accelerate your ZK development with ICICLE.
 
-[ICICLE-OVERVIEW]: ./icicle/overview.md
+<!-- Being Links -->
 [Discord]: https://discord.gg/6vYrE7waPj
+[Github]: https://github.com/ingonyama-zk
+[SupportEmail]: mailto:[email protected]
+<!-- End Links -->