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.

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

Improve the explanation of context in frontend.mdx and backend.mdx #18

Open
adithyaakrishna opened this issue Oct 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@adithyaakrishna
Copy link
Contributor

The concept of 'context' in Reclaim Protocol is crucial but could be explained more clearly and comprehensively in both the frontend.mdx and backend.mdx files.

Tasks:

  1. In both files, expand the section on context to include:
    • A clear definition of what 'context' means in Reclaim Protocol
    • The importance of context in securing proofs and preventing misuse
    • Detailed explanation of the 'address' and 'message' components of context
  2. Add more diverse examples of how context can be used effectively:
    • Example for a blockchain application using the address field
    • Example for a web application using the message field for freshness
    • Example combining both address and message for maximum security
  3. Include best practices for generating and verifying context
  4. Add a section on common pitfalls or misunderstandings about context
  5. Provide code snippets demonstrating how to add, retrieve, and verify context in both frontend and backend implementations
  6. Include a troubleshooting section for context-related issues

Enhancing this explanation will help developers better understand and utilize the context feature, improving the security and specificity of their Reclaim Protocol implementations.

Contributors: Please note that by submitting a pull request, you are agreeing to accept and sign the Contributor License Agreement (CLA) found at https://github.com/reclaimprotocol/.github/blob/main/CLA.md

@adithyaakrishna adithyaakrishna added documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest labels Oct 1, 2024
@adithyaakrishna adithyaakrishna added the good first issue Good for newcomers label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant