0xpolygonmiden/miden-docs

Consolidated documentation for the Miden rollup

miden-docs

Consolidated documentation for the Miden rollup

miden-docs's Issues

Consolidated Miden docs in this repo

We should link other Miden repos (e.g., miden-base, miden-node, miden-client) to this repo as sub modules and have a simple script which copies does and organizes them into the structure which looks something like this:

Miden
├── Overview
├── Get started
│   ├── Core concepts
│   └── Tutorials
├── How to
│   ├── Write a smart contract
│   └── Deploy a smart contract
├── Smart contracts
│   ├── Overview
│   ├── Miden SDK
│   └── Examples
├── Miden node
│   ├── Overview
│   ├── Deployment
│   └── API
├── Miden client
│   ├── Overview
│   ├── CLI
│   └── Library
└── Architecture
    ├── Accounts
    ├── Notes
    ├── Assets
    ├── Transactions
    ├── State
    └── Kernels

The source of this docs should be:

• Overview: probably written here directly.
• Get started: probably written here directly.
• How to: eventually should come from Miden compiler/SDK repos. And maybe it makes sense to combine with `Smart contracts" section.
• Smart contracts: eventually should come from Miden compiler/SDK repos.
• Miden node should come from miden-node repo.
• Miden client should come from miden-client repo.
• Architecture should come from miden-base repo.