reclaimprotocol / reclaimprotocol/docs

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

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue hacktoberfest
Dominant language
MDX
Stars
10
Forks
14
PR merge metrics
No merged PRs in 30d

Description

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

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.

Research direction

Start by reading the existing context sections in frontend.mdx and backend.mdx and compare how each implementation currently explains context. Expand both files with the requested definitions, examples, best practices, pitfalls, code snippets, and troubleshooting guidance. Done means both pages comprehensively cover adding, retrieving, and verifying context for frontend and backend users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.