Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix broken links in libraries and poseidon sections #752

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ eIcicleError result = icicle_set_device(device);
// Any call will now execute on GPU-0
```

Full details can be found in our [getting started docs](https://dev.ingonyama.com/icicle/introduction)
Full details can be found in our [getting started docs](https://dev.ingonyama.com/icicle/getting_started)

## Contributions

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/icicle/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Each library has a corresponding crate. See [programmers guide](./programmers_gu

#### Supported fields and operations

| Operation\Field | [babybear](https://eprint.iacr.org/2023/824.pdf) | [Stark252](https://docs.starknet.io/documentation/architecture_and_concepts/Cryptography/p-value/) | m31 | Koalabear |
| Operation\Field | [babybear](https://eprint.iacr.org/2023/824.pdf) | [Stark252](https://docs.starknet.io/architecture-and-concepts/cryptography/#stark-field) | m31 | Koalabear |
| ----------------------------------------- | :----------------------------------------------: | :------------------------------------------------------------------------------------------------: | :---: | :---: |
| [Vector operations](./primitives/vec_ops) | ✅ | ✅ | ✅ | ✅ |
| [Polynomials](./polynomials/overview) | ✅ | ✅ | ❌ | ✅ |
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/icicle/primitives/poseidon.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ So for Poseidon of arity 2 and input of size 1024 * 2, we would expect 1024 elem

Poseidon is extremely customizable and using different constants will produce different hashes, security levels and performance results.

We support pre-calculated and optimized constants for each of the [supported curves](../libraries#supported-curves-and-operations).The constants can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/poseidon/constants) and are labeled clearly per curve `<curve_name>_poseidon.h`.
We support pre-calculated and optimized constants for each of the [supported curves](../libraries#supported-curves-and-operations).The constants can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/icicle/hash/poseidon_constants/constants) and are labeled clearly per curve `<curve_name>_poseidon.h`.

If you wish to generate your own constants you can use our python script which can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/poseidon/constants/generate_parameters.py).
If you wish to generate your own constants you can use our python script which can be found [here](https://github.com/ingonyama-zk/icicle/blob/main/icicle/include/icicle/hash/poseidon_constants/constants/generate_parameters.py).

Prerequisites:

Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ export default {
{
type: "link",
label: "Ingopedia",
href: "https://www.ingonyama.com/ingopedia"
href: "https://www.ingonyama.com/ingopedia/communityguide"
},
{
href: 'https://github.com/ingonyama-zk',
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-3.2.0/icicle/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Each library has a corresponding crate. See [programmers guide](./programmers_gu

#### Supported fields and operations

| Operation\Field | [babybear](https://eprint.iacr.org/2023/824.pdf) | [Stark252](https://docs.starknet.io/documentation/architecture_and_concepts/Cryptography/p-value/) | m31 |
| Operation\Field | [babybear](https://eprint.iacr.org/2023/824.pdf) | [Stark252](https://docs.starknet.io/architecture-and-concepts/cryptography/#stark-field) | m31 |
| ----------------------------------------- | :----------------------------------------------: | :------------------------------------------------------------------------------------------------: | :---: |
| [Vector operations](./primitives/vec_ops) | ✅ | ✅ | ✅ |
| [Polynomials](./polynomials/overview) | ✅ | ✅ | ❌ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ So for Poseidon of arity 2 and input of size 1024 * 2, we would expect 1024 elem

Poseidon is extremely customizable and using different constants will produce different hashes, security levels and performance results.

We support pre-calculated and optimized constants for each of the [supported curves](../libraries#supported-curves-and-operations).The constants can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/poseidon/constants) and are labeled clearly per curve `<curve_name>_poseidon.h`.
We support pre-calculated and optimized constants for each of the [supported curves](../libraries#supported-curves-and-operations).The constants can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/icicle/hash/poseidon_constants/constants) and are labeled clearly per curve `<curve_name>_poseidon.h`.

If you wish to generate your own constants you can use our python script which can be found [here](https://github.com/ingonyama-zk/icicle/tree/main/icicle/include/poseidon/constants/generate_parameters.py).
If you wish to generate your own constants you can use our python script which can be found [here](https://github.com/ingonyama-zk/icicle/blob/main/icicle/include/icicle/hash/poseidon_constants/constants/generate_parameters.py).

Prerequisites:

Expand Down