Creating a ZK standalone page

Open
#2,285 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #2243 by @PiVortex — closed without merging

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
blockchain
Domain
cryptography, documentation

Research direction

Start by verifying that Reclaim Protocol and the Groth16 verifier work and are easy enough for readers to use. Then author the standalone page in the documentation with relevant code snippets showing how to use these tools; done means both tools are verified and the page covers the worthwhile working resources.

Written by the indexing model from the issue text.

Description

What?

Create a page showcasing ZK tools in the ecosystem and in some cases how to use them.

Why?

People are not aware that these resources exist. We should try to feature all worthwhile working tools in our documentation.

How?

  • Research tools available (the main worth documenting are Reclaim Protocol and Groth16 verifier).
  • Verify that these tools work and are easy enough to get started with.
  • Author a page in docs with relevant code snippets showing you how to use the tech.
Dominant language
MDX
Stars
186
Forks
493
Avg merge
29d 5h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from near/docs

All issues in near/docs

Similar issues

More Cryptography issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.