reclaimprotocol / reclaimprotocol/docs

Enhance explanation of TLS and proof of provenance in whitepaper.mdx

Open
#13 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 whitepaper.mdx file currently provides a brief overview of how TLS is used in Reclaim Protocol and how proofs of provenance are generated. However, this section could be significantly expanded to provide a more comprehensive understanding for technical readers.

Tasks:

  1. Provide a more detailed explanation of the TLS protocol and its role in Reclaim.
  2. Elaborate on the process of generating proofs of provenance, including the cryptographic techniques used.
  3. Add diagrams or flowcharts to visually represent these processes.
  4. Include a section on the security implications and advantages of this approach.
  5. Provide examples of how these proofs can be practically applied in various use cases.

This enhancement will help readers better understand the technical foundations of the protocol and its security benefits.

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

Read whitepaper.mdx first to understand its existing TLS and proof-of-provenance sections. Expand the protocol, cryptographic process, security implications, diagrams, and practical use cases described in the issue; the work is done when each requested topic is covered clearly in the whitepaper.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.