The goal of this repository is to provide clear and practical examples for interacting with the Miden Rollup. These examples are designed to ensure a smooth onboarding experience for developers exploring Miden's capabilities.
This repository is organized into several parts:
- docs, contains the README files for the tutorials and guides.
- masm, contains the Miden assembly notes, accounts, and scripts used in the examples.
- rust-client, contains examples for interacting with the Miden Rollup using Rust.
- web-client, contains examples for interacting with the Miden Rollup in the browser.
The documentation (tutorials) in the docs folder is built using Docusaurus and is automatically absorbed into the main miden-docs repository for the main documentation website. Changes to the next branch trigger an automated deployment workflow. The docs folder requires npm packages to be installed before building.
The documentation folder is also a standalone Rust repository. The purpose of this is to be able to run cargo doc test, to test the Rust code inside of the tutorial markdowns.