Skip to content
This repository has been archived by the owner on Nov 9, 2023. It is now read-only.

#ITEM 2 - Finnish docs and examples for Ristretto release #92

Open
CPerezz opened this issue Oct 14, 2019 · 2 comments
Open

#ITEM 2 - Finnish docs and examples for Ristretto release #92

CPerezz opened this issue Oct 14, 2019 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request team:R&D Research & Development (Cryptographic Protocol)

Comments

@CPerezz
Copy link
Contributor

CPerezz commented Oct 14, 2019

Currently, we need to:

  • Add some docs about how Ristretto works and some code examples on the ristretto.rs file.
  • Review all of the library comments in order to make sure that they are correct.
  • Refactor the examples of the library and include a ECDH one.
@CPerezz CPerezz added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 14, 2019
@CPerezz CPerezz added this to the Ristretto Release milestone Oct 14, 2019
@LukePearson1
Copy link
Contributor

  • I will get started with this today. What format do you want to go for? Something on the read me for the docs, or added text in the docs file? I feel writing a short paper, even 1 or two pages, would be fruitless. Regarding the code examples, I can perform them and point out the step such as torquing points, as well as lack of need to multiply by the cofactor.

  • I will do one large audit once again, after I've performed the above tasks, last time I missed one thing from which @ZER0 corrected in his PR. Hopefully there's nothing else to catch.

  • By 'Refactor the examples', what are you referring to exactly? @CPerezz

@CPerezz
Copy link
Contributor Author

CPerezz commented Oct 14, 2019

Refactor examples will be basically refactor the examples we have inside of the examples folder.

I was basically talking about adding some doc-comments on the ristretto.rs file (I'll do it). And maybe also it's time to refactor the README.md.

No papers or huge refactorings were thought from my side.

@ZER0 ZER0 added the team:R&D Research & Development (Cryptographic Protocol) label Jan 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request team:R&D Research & Development (Cryptographic Protocol)
Projects
None yet
Development

No branches or pull requests

3 participants