Add build folder to gitignote. Fix more broken links

ingonyama-zk · Nov 21, 2024 · 333997a · 333997a
1 parent 110ee06
commit 333997a
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 8 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -2,6 +2,7 @@
 node_modules/
 yarn.lock
 .DS_Store
+build/
 
 # tex build artifacts
 .aux

diff --git a/docs/docs/icicle/overview.md b/docs/docs/icicle/overview.md
@@ -80,5 +80,5 @@ If you have any questions or need support, feel free to reach out on [Discord],
 <!-- Being Links -->
 [Discord]: https://discord.gg/6vYrE7waPj
 [Github]: https://github.com/ingonyama-zk
-[SupportEmail]: support@ingonyama.com
+[SupportEmail]: mailto:support@ingonyama.com
 <!-- End Links -->
diff --git a/docs/versioned_docs/version-1.10.1/icicle/introduction.md b/docs/versioned_docs/version-1.10.1/icicle/introduction.md
@@ -1,6 +1,6 @@
 # Getting started with ICICLE
 
-This guide is oriented towards developers who want to start writing code with the ICICLE libraries. If you just want to run your existing ZK circuits on GPU refer to [this guide](./integrations.md#using-icicle-integrations) please.
+This guide is oriented towards developers who want to start writing code with the ICICLE libraries. If you just want to run your existing ZK circuits on GPU refer to [this guide](./integrations.md#using-icicle-integrated-provers) please.
 
 ## ICICLE repository overview
 

diff --git a/docs/versioned_docs/version-2.8.0/icicle/introduction.md b/docs/versioned_docs/version-2.8.0/icicle/introduction.md
@@ -1,6 +1,6 @@
 # Getting started with ICICLE
 
-This guide is oriented towards developers who want to start writing code with the ICICLE libraries. If you just want to run your existing ZK circuits on GPU refer to [this guide](./integrations.md#using-icicle-integrations) please.
+This guide is oriented towards developers who want to start writing code with the ICICLE libraries. If you just want to run your existing ZK circuits on GPU refer to [this guide](./integrations.md#using-icicle-integrated-provers) please.
 
 ## ICICLE repository overview
 
@@ -18,7 +18,7 @@ Based on this dependency architecture, the ICICLE repository has three main sect
 
 ### ICICLE Core
 
-[ICICLE Core](/icicle/core) is a library that directly works with GPU by defining CUDA kernels and algorithms that invoke them. It contains code for [fast field arithmetic](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/field/field.cuh), cryptographic primitives used in ZK such as [NTT](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/ntt/), [MSM](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/msm/), [Poseidon Hash](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/poseidon/), [Polynomials](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/polynomials/) and others.
+[ICICLE Core](./core.md) is a library that directly works with GPU by defining CUDA kernels and algorithms that invoke them. It contains code for [fast field arithmetic](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/field/field.cuh), cryptographic primitives used in ZK such as [NTT](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/ntt/), [MSM](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/msm/), [Poseidon Hash](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/poseidon/), [Polynomials](https://github.com/ingonyama-zk/icicle/tree/main/icicle/src/polynomials/) and others.
 
 ICICLE Core would typically be compiled into a static library and either used in a third party language such as Rust or Golang, or linked with your own C++ project.
 

diff --git a/docs/versioned_docs/version-3.0.0/icicle/multi-device.md b/docs/versioned_docs/version-3.0.0/icicle/multi-device.md
@@ -75,5 +75,3 @@ extern "C" eIcicleError icicle_get_device_count(int& device_count /*OUT*/);
   
 - **Launch One CPU Thread per Device:** To avoid [common errors](https://developer.nvidia.com/blog/cuda-pro-tip-always-set-current-device-avoid-multithreading-bugs/) and ensure code readability, we recommend creating a dedicated thread for each device. Within each CPU thread, you can launch as many tasks as you like for a device, as long as they all run on the same device ID. This will make your code more manageable, easier to read, and performant.
 ---
-
-This guide provides an overview of multi-device support in ICICLE, explaining the approaches and best practices for efficiently scaling ZK computations across multiple devices. For further information or support, please refer to our [documentation](./) or join the discussion on [Discord](https://discord.gg/6vYrE7waPj).
diff --git a/docs/versioned_docs/version-3.0.0/icicle/overview.md b/docs/versioned_docs/version-3.0.0/icicle/overview.md
@@ -76,4 +76,4 @@ Explore the full capabilities of ICICLE by diving into the [Architecture](./arch
 If you have any questions or need support, feel free to reach out on [Discord], [GitHub](https://github.com/ingonyama-zk) or [via support email][SupportEmail]. We're here to help you accelerate your ZK development with ICICLE.
 
 [Discord]: https://discord.gg/6vYrE7waPj
-[SupportEmail]: support@ingonyama.com
+[SupportEmail]: mailto:support@ingonyama.com
diff --git a/docs/versioned_docs/version-3.1.0/icicle/overview.md b/docs/versioned_docs/version-3.1.0/icicle/overview.md
@@ -78,5 +78,5 @@ If you have any questions or need support, feel free to reach out on [Discord],
 <!-- Being Links -->
 [Discord]: https://discord.gg/6vYrE7waPj
 [Github]: https://github.com/ingonyama-zk
-[SupportEmail]: support@ingonyama.com
+[SupportEmail]: mailto:support@ingonyama.com
 <!-- End Links -->