Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/cut-versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ jobs:
# Clean directories that will be re-synced (v0.4 nested paths)
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
rm -rf docs/builder/tools/client
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
rm -rf docs/builder/tutorials/miden-bank docs/builder/tutorials/index.md
# Note: docs/builder/tutorials/rust-compiler/ is NOT cleaned to preserve local guides (testing, debugging, pitfalls)

# Core Concepts docs → docs/core-concepts/*
if [ -d "vendor/miden-base/docs/src" ]; then
Expand Down Expand Up @@ -220,7 +221,8 @@ jobs:
rm -rf docs/core-concepts/miden-node
rm -rf docs/core-concepts/compiler
rm -rf docs/builder/tools/client
# Note: tutorials live in docs/builder/tutorials/ (authored content, not cleaned)
rm -rf docs/builder/tutorials/miden-bank docs/builder/tutorials/index.md
# Note: docs/builder/tutorials/rust-compiler/ is authored content (testing, debugging, pitfalls), not cleaned

- name: Commit snapshots
run: |
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ jobs:
# Clean directories that will be re-synced (v0.4 nested paths)
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
rm -rf docs/builder/tools/client
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
rm -rf docs/builder/tutorials/miden-bank docs/builder/tutorials/index.md
# Note: docs/builder/tutorials/rust-compiler/ is NOT cleaned to preserve local guides (testing, debugging, pitfalls)

# Core Concepts docs → docs/core-concepts/*
if [ -d "vendor/miden-base/docs/src" ]; then
Expand Down
2 changes: 1 addition & 1 deletion docs/builder/smart-contracts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Reference documentation for building Miden smart contracts in Rust

# Miden Smart Contracts

This section is the complete reference for building smart contracts on Miden using Rust and the Miden SDK (v0.10). If you're new to Miden, follow the hands-on [Miden Bank Tutorial](../tutorials/rust-compiler/miden-bank/).
This section is the complete reference for building smart contracts on Miden using Rust and the Miden SDK (v0.10). If you're new to Miden, follow the hands-on [Miden Bank Tutorial](../tutorials/miden-bank/).

All Miden Rust contracts compile under these constraints: `#![no_std]`, Rust 2024 edition.

Expand Down
4 changes: 2 additions & 2 deletions docs/builder/smart-contracts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Miden's execution model, account structure, note system, and trans

# What is a Miden Smart Contract

Miden is a ZK rollup where transactions execute on the client and only a cryptographic proof is submitted to the network. Every entity — wallets, contracts, faucets — is an account with code, storage, a vault, and a nonce. Assets move between accounts through notes, which act as programmable UTXOs. This page describes the execution model, account structure, note system, and transaction lifecycle. For a hands-on walkthrough, see the [Miden Bank Tutorial](../tutorials/rust-compiler/miden-bank/).
Miden is a ZK rollup where transactions execute on the client and only a cryptographic proof is submitted to the network. Every entity — wallets, contracts, faucets — is an account with code, storage, a vault, and a nonce. Assets move between accounts through notes, which act as programmable UTXOs. This page describes the execution model, account structure, note system, and transaction lifecycle. For a hands-on walkthrough, see the [Miden Bank Tutorial](../tutorials/miden-bank/).

## What makes Miden different

Expand Down Expand Up @@ -148,4 +148,4 @@ Miden supports several account types, configured in `Cargo.toml`:
| [Cross-Component Calls](./cross-component-calls) | Inter-component communication | WIT bindings, `generate!()` |
| [Types](./types) | Felt, Word, Asset — the VM's native types | Field arithmetic |

Ready to start building? Follow the [Miden Bank Tutorial](../tutorials/rust-compiler/miden-bank/) for a hands-on walkthrough.
Ready to start building? Follow the [Miden Bank Tutorial](../tutorials/miden-bank/) for a hands-on walkthrough.
2 changes: 1 addition & 1 deletion docs/builder/smart-contracts/patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Common patterns and security considerations for Miden smart contra

# Patterns

Security considerations and common patterns for Miden smart contracts. For runnable examples, see the [compiler examples directory](https://github.com/0xMiden/compiler/tree/next/examples) and the [Miden Bank Tutorial](../tutorials/rust-compiler/miden-bank/).
Security considerations and common patterns for Miden smart contracts. For runnable examples, see the [compiler examples directory](https://github.com/0xMiden/compiler/tree/next/examples) and the [Miden Bank Tutorial](../tutorials/miden-bank/).

## Access control

Expand Down
2 changes: 1 addition & 1 deletion docs/builder/tutorials/rust-compiler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you're new to the Miden Rust compiler, start with the **Miden Bank Tutorial**
</ul>
</div>
<div className="card__footer">
<a className="button button--primary button--block" href="./miden-bank/">Start Tutorial</a>
<a className="button button--primary button--block" href="../miden-bank/">Start Tutorial</a>
</div>
</div>
</div>
Expand Down
Loading