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.

Sign up for GitHub

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

Jump to bottom

Documentation Enhancement: Improve JS Library Section #18

Open
rajeshb62 opened this issue Nov 6, 2024 · 0 comments · May be fixed by #19
Open

Documentation Enhancement: Improve JS Library Section #18

rajeshb62 opened this issue Nov 6, 2024 · 0 comments · May be fixed by #19

Comments

@rajeshb62
Copy link

Documentation Enhancement: Improve JS Library Section

Current Status

The current JS library section in the README could be more detailed and user-friendly.

Proposed Changes

I plan to enhance the JS library documentation with:

  1. Clear explanation of the full workflow from raw email to proof verification
  2. Example email and its intermediate numeric outputs
  3. Step-by-step code examples showing:
    • Input generation
    • Proof generation
    • Proof verification
  4. Better explanation of custom circuit usage

Benefits

  • Makes it easier for new users to understand the workflow
  • Provides concrete examples of input/output formats
  • Shows complete working code samples
  • Improves overall documentation clarity

Would you be interested in a PR implementing these changes?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: enhance JS library section with detailed examples rajeshb62/zkemail.nr
1 participant
@rajeshb62