consensys / doc.gnark

gnark is a fast, open-source library for zero-knowledge proof protocols written in Go.

gnark documentation

This documentation repository is built using Docusaurus, and the doc site is published at docs.gnark.consensys.net.

View the ConsenSys doc contribution guidelines for information about submitting documentation changes and previewing the site locally.

doc.gnark's Issues

Updating the PRE-IMAGE proof example in Overview page

The 'EXAMPLE OF HOW TO PROVE KNOWLEDGE OF A PRE-IMAGE' on the Overview page is outdated and doesn't run on the current version of gnark.
The old example
Circuit definition is wrong (for example mimc.NewMiMC(api.Curve()) shouldn't receive a curve as input, the API is sufficient).

Add documentation for `v0.5.1`

Including:

• cs.NewHint()
• backend.ProverOption
• frontend.ConstraintSystem -> frontend.API
• bug fixes ...

update landing page with link & thumbnail to playground.

https://play.gnark.io

update code samples with new witness API

• Serialization page with up to date witness serialization API

Add bls24-315

@yelhousni can you do a PR on the docs with bls24-315 support?

Update doc with `Hints`

add documentation for `pprof` profiling like feature

See Consensys/gnark#352

update landing page with gnark specific descriptions

#19 need a bit of polishing to update the landing page with gnark specific text (right now we the quick links section looks like for EthSigner;

).

Also few broken links for example:
https://docs.gnark.consensys.net/Reference/api -_> "Front End" and "Back End" links are broken ( https://pkg.go.dev/github.com/consensys/gnark@%7B%7Bcontent_vars.gnark_version%7D%7D/frontend )

Update user-doc for v0.6.0