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

Add documentation for Miden crypto #284

Open
Dominik1999 opened this issue Mar 2, 2024 · 1 comment
Open

Add documentation for Miden crypto #284

Dominik1999 opened this issue Mar 2, 2024 · 1 comment

Comments

@Dominik1999
Copy link
Collaborator

We want documentation for Miden crypto

As described in 0xPolygonMiden/miden-base#472, we want documentation for the Miden crypto. The documentation source files should be located in the crypto repo. Then, developers can update the docs using the same PR as the code.

Target group for the Miden crypto docs

We have different target groups for our documentation:

  1. People who want to develop on top of Polygon Miden - e.g., write new smart contracts (accounts, notes), build new applications, etc. For them, they should be able to understand the underlying primitives and trade-offs
  2. People who want to contribute to Polygon Miden - e.g., those who may be interested in making proposals to improve the cryptography or contribute to the development etc.
  3. People who want to use Polygon Miden. For now, this is mostly people who may want to play with it - but in the future, it can be people who want to participate in running the network.

For now, the order of importance is the above.

Proposed structure

  • let's discuss / settle on a structure in this issue

Mkdocs

We are going to use Mkdocs and a plugin to build the Miden unified docs in docs.polygon.technology.

So please build the docs with mkdocs material already in mind.

@bobbinth
Copy link
Contributor

bobbinth commented Mar 3, 2024

I think the structure could largely follow what we have in the main readme - e.g.,

  • Hash functions
  • Merkel structures
  • Digital signatures

We'll need to write a bit more content for each section (to explain constructions in more detail, as well as motivation and relevance for the Miden rollup) - but other than that, the docs should be fairly straightforward.

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