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

update poseidon2 docs #681

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

update poseidon2 docs #681

wants to merge 15 commits into from

Conversation

krakhit
Copy link
Contributor

@krakhit krakhit commented Dec 8, 2024

Describe the changes

This PR...

Adds some clarifications in version2
docs/versioned_docs/version-3.2.0/icicle/primitives/hash.md
-minor changes
docs/versioned_docs/version-3.2.0/icicle/primitives/poseidon2.md

  • added rust API example in examples/rust/poseidon2/src/main.rs and in description
  • added rust API Merkle example in examples/rust/poseidon2/src/main.rs and in description
  • added theory part
  • synced docs/versioned_docs/version-3.2.0/icicle/primitives/poseidon2.md and docs/icicle/primitives/poseidon2.md

Linked Issues

Resolves #

@yshekel
Copy link
Collaborator

yshekel commented Dec 8, 2024

@yshekel yshekel changed the title Danny poseidon2 docs/v3.2 update poseidon2 docs Dec 8, 2024
@jeremyfelder
Copy link
Collaborator

@krakhit Note that the current changes are for the next versions docs. Updates to a released version should be done in that version's specific docs: https://github.com/ingonyama-zk/icicle/tree/main/docs/versioned_docs/version-3.2.0

@krakhit krakhit requested a review from yshekel December 9, 2024 14:15
@krakhit
Copy link
Contributor Author

krakhit commented Dec 9, 2024

@yshekel : If you could review the example for Merkle Tree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants