jose-compu / jose-compu/opencircom
docs: Glossary of ZK circuit terms used in templates
- Dominant language
- Circom
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
## Why
Nullifiers, Merkle paths, Poseidon arity, etc. appear without a beginner glossary.
## Task
Add a short glossary (README section or `docs/GLOSSARY.md`) for terms used by opencircom templates. Keep non-academic and accurate.
## Acceptance
- [ ] Linked from README
- [ ] Covers hashing, Merkle inclusion, nullifier, comparator at minimum
## Difficulty
Beginner — documentation only.
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the README and the opencircom templates to identify the terms used by them. Add a short, non-academic glossary in the README or docs/GLOSSARY.md, link it from the README, and ensure it covers hashing, Merkle inclusion, nullifiers, and comparators.
Written by the indexing model from the issue text.
Assessment
- Domain
- cryptography, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100