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: add more "godoc-like" ExampleXXX #460

Open
gbotrel opened this issue Feb 7, 2023 · 1 comment
Open

docs: add more "godoc-like" ExampleXXX #460

gbotrel opened this issue Feb 7, 2023 · 1 comment
Labels
doc-change-required Indicates an issue or PR that requires doc to be updated

Comments

@gbotrel
Copy link
Collaborator

gbotrel commented Feb 7, 2023

If they match the ones in docs.gnark.consensys.net, that would help too.

Things like "how to [de]serialize a proving key, circuit" or "how to test my circuit without running the prover" are recurrent questions.

@gbotrel gbotrel added the doc-change-required Indicates an issue or PR that requires doc to be updated label Feb 7, 2023
@gbotrel gbotrel added this to the v0.8.0 milestone Feb 7, 2023
@gbotrel gbotrel modified the milestones: v0.8.0, v0.9.0 Feb 14, 2023
@ivokub
Copy link
Collaborator

ivokub commented Mar 8, 2023

To add, I think there definitely has to be something at root package github.com/consensys/gnark. Right now when looking at package doc then it is really confusing where to start from. And there are so many sub-packages that it doesn't help (i.e. we describe writing circuits in frontend, but there is no direct reference to start from there).

@ivokub ivokub removed this from the v0.9.0 milestone Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-change-required Indicates an issue or PR that requires doc to be updated
Projects
None yet
Development

No branches or pull requests

2 participants