Skip to content

Documentation Enhancement: Improve JS Library Section #18

@rajeshb62

Description

@rajeshb62

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions