0xMiden / 0xMiden/miden-vm

Add documentation for Miden crypto

Ouverte
#3,485 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
documentation
Langage dominant
Rust
Étoiles
772
Forks
352
Merge moyen
1 j 12 h
PR mergées (30 j)
93

Description

# We want documentation for Miden crypto

As described in https://github.com/0xPolygonMiden/miden-base/issues/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](https://github.com/jdoiro3/mkdocs-multirepo-plugin) to build the Miden unified docs in [docs.polygon.technology](https://docs.polygon.technology/miden/).

So please build the docs with [mkdocs](https://squidfunk.github.io/mkdocs-material/) material already in mind.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.