0xPolygonMiden / miden-node

Reference implementation of the node for the Polygon Miden rollup
MIT License
53 stars 37 forks source link

Add docs for the Miden Node #244

Open Dominik1999 opened 8 months ago

Dominik1999 commented 8 months ago

We need docs for the Miden Node

As described in https://github.com/0xPolygonMiden/miden-base/issues/472, we want documentation for the Miden Node. The source files of the documentation should be located in the Node repo. Then, developers can update the docs in the same PR as the code.

Target group for the Miden Node docs

We have different target groups for our documentation:

  1. 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.
  2. People who want to develop on top of Polygon Miden - e.g., write new smart contracts (accounts, notes), build new applications, etc.
  3. People who want to contribute to Polygon Miden - e.g., those who may be interested in making proposals to improve the protocol or contribute to note/client development etc.

For now, the order of importance is the above. That means the docs should be super clear about how to interact with the Miden Node.

Proposed structure

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 having mkdocs material already in mind.

bobbinth commented 8 months ago

How to run a Node: There is no need to put a lot of effort here, since atm we don't expect ppl to run a node

This could still be useful for people who want to run nodes for local dev/testing purposes.