docs: update documentation to latest gnark release - #91
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
alexandratran
approved these changes
Sep 23, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Changes are limited to markdown documentation and example snippets; no library or runtime behavior is modified.
Overview
Documentation-only refresh aligning gnark docs with the current release APIs and supported backends.
Concepts & onboarding: Constraint-size guidance no longer cites a fixed BN254 Groth16 cap; it stresses measuring proving time and memory. Proving-schemes/curves content is corrected (title, PlonK + KZG wording) and the supported Groth16/PlonK pairing curves are narrowed to BN254, BLS12-381, BLS12-377, and BW6-761, with a new section on small fields and
std/math/emulated. Get-started now targets Go 1.25+ and mentions ICICLE GPU Groth16.How-to flows: Examples consistently use
ecc.*.ScalarField()for compile/witness, explicit error handling, and updated witness JSON (NewSchema,ToJSON/FromJSON). PlonK is documented as supported (compile withscs,unsafekzgSRS for dev,plonk.Setup/Prove/Verify). Testing favorstest.CheckCircuitwith valid/invalid assignments and optional curve/backend filters; hints are rewritten aroundsolver.Hint,api.Compiler().NewHint, andbackend.WithSolverOptions(solver.WithHints(...)). Solidity export notes PlonK on BN254 andsolidity.With*prover/verifier options.Tutorials & reference: The EdDSA tutorial is shortened to the maintained
stdgadget flow (Assign,CheckCircuit, Groth16). Standard library tabs show current MiMC, EdDSA, Merkle, and recursion verifier APIs. API reference adds links tostdandtest.Reviewed by Cursor Bugbot for commit 4e377a0. Bugbot is set up for automated code reviews on this repo. Configure here.