arkworks-rs / arkworks-rs/r1cs-tutorial
README for part #1 of the R1CS Tutorial is misguiding
- Dominant language
- Rust
- Stars
- 264
- Forks
- 91
- PR merge metrics
- No merged PRs in 30d
Description
∂
## Summary of Bug
The README for the _merkle tree example_ in the R1CS tutorial incorrectly states that it will show how to invoke a SNARK when actually the example is only about generating the constraints and verifying satisfiability directly using the witness input itself. This is confusing for beginners trying to learn arkworks.
## Version
commit 5d3a9022fb6deade245505748fd661278e9c0ff9
## Steps to Reproduce
Compare the README to the example code.
Contributor guide
Research direction
Open the README for the merkle tree example and compare its claim about invoking a SNARK with the example code. Update the description to accurately reflect that the example generates constraints and verifies satisfiability using the witness input, then confirm the README no longer misleads beginners.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100