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

Improving docs for the getting started section #150

Open
cwkang1998 opened this issue Feb 16, 2023 · 1 comment · May be fixed by #154
Open

Improving docs for the getting started section #150

cwkang1998 opened this issue Feb 16, 2023 · 1 comment · May be fixed by #154
Labels
documentation Improvements or additions to documentation

Comments

@cwkang1998
Copy link

In the getting started section -> Proving circuits with ZK, the contents can be a bit clearer. I believe (and I might be wrong, new into circom) that there's a missing beacon step for the phase 2 section of the doc, where its lacking a snarkjs beacon to end the phase, which is actually documented here https://github.com/iden3/snarkjs/blob/master/README.md.

Would love to see that added to the docs, and also with a bit more clarity to only use the final zkey for exporting verifier.sol, since only then will the verifier work as expected when verifying the inputs (clearly I got bitten by this xD).

Would be happy to add to the docs on this as well!

@rkdud007
Copy link

LGTM, we need to add to docs for prevent later confusion!

@miguelis miguelis added the documentation Improvements or additions to documentation label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants