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

Structure of Documentation #2

Open
kevaundray opened this issue Sep 22, 2021 · 2 comments
Open

Structure of Documentation #2

kevaundray opened this issue Sep 22, 2021 · 2 comments

Comments

@kevaundray
Copy link
Collaborator

This issue is being used to track what roughly will be placed in the docs, subject to change.

We can split the documentation into two parts; cryptography/technical aspects and ethereum specific topics.

This documentation will for the most part, focus on the cryptography and only allude or expand on ethereum specific topics when it directly affects the technical aspects.

For the technical aspects, some categories I think will be useful:

  • Overview
  • Opening proof, PCS
  • Test Vectors
  • Implementations
  • Optimisations - Eg. Recomputing commitment without computing every value, precomputing CRS points for scalar multiplication

Note

  • Overview is needed to provide a narrative for the rest of the chapters, so things do not seem random.
  • It may be helpful to start off with a non-optimised easy to understand implementation and then iterate to what we have now.
  • Each chapter should also have a summary section, where we say what functionality the concept provides. So for PCS, the summary may say something like "This allows us to commit to a vector and produce short proofs of the values in that vector using it's commitment"
@JEAlfonsoP
Copy link
Contributor

I would suggest a math concepts section in /docs (as my own experience as soon as you understand math life is in a way easier). If you agree I can PR for review.
Also I would be more than happy to contribute on this repo.

@kevaundray
Copy link
Collaborator Author

Sounds good, please make a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants