diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index ef8eee7646..5e813a8d26 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -109,6 +109,7 @@ const config: Config = { src: "img/logo.png", alt: "Miden Logo", height: 240, + href: "/protocol", }, title: "MIDEN", items: [ diff --git a/docs/src/_category_.yml b/docs/src/protocol/_category_.yml similarity index 100% rename from docs/src/_category_.yml rename to docs/src/protocol/_category_.yml diff --git a/docs/src/account/_category_.yml b/docs/src/protocol/account/_category_.yml similarity index 100% rename from docs/src/account/_category_.yml rename to docs/src/protocol/account/_category_.yml diff --git a/docs/src/account/address.md b/docs/src/protocol/account/address.md similarity index 100% rename from docs/src/account/address.md rename to docs/src/protocol/account/address.md diff --git a/docs/src/account/code.md b/docs/src/protocol/account/code.md similarity index 100% rename from docs/src/account/code.md rename to docs/src/protocol/account/code.md diff --git a/docs/src/account/components.md b/docs/src/protocol/account/components.md similarity index 100% rename from docs/src/account/components.md rename to docs/src/protocol/account/components.md diff --git a/docs/src/account/id.md b/docs/src/protocol/account/id.md similarity index 100% rename from docs/src/account/id.md rename to docs/src/protocol/account/id.md diff --git a/docs/src/account/index.md b/docs/src/protocol/account/index.md similarity index 95% rename from docs/src/account/index.md rename to docs/src/protocol/account/index.md index e43aaee065..a158a2021e 100644 --- a/docs/src/account/index.md +++ b/docs/src/protocol/account/index.md @@ -4,7 +4,7 @@ sidebar_position: 1 # Accounts / Smart Contracts -An `Account` represents the primary entity in Miden. It is capable of holding assets, storing data, and executing custom code. Each `Account` is a smart contract with a programmable interface through which note and transaction scripts can interact with the account's state and assets. By executing [transactions](../transaction) against an account, its state can be modified. +An `Account` represents the primary entity in Miden. It is capable of holding assets, storing data, and executing custom code. Each `Account` is a smart contract with a programmable interface through which note and transaction scripts can interact with the account's state and assets. By executing [transactions](../transaction.md) against an account, its state can be modified. ## What is the purpose of an account? @@ -46,7 +46,7 @@ Note that a transaction does not always change the state of an account. For inst ## Account creation -For an `Account` to be recognized by the network, it must exist in the [account database](../state#account-database) maintained by Miden node(s). +For an `Account` to be recognized by the network, it must exist in the [account database](../state.md#account-database) maintained by Miden node(s). However, a user can locally create a new `Account` ID before it's recognized network-wide. The typical process might be: diff --git a/docs/src/account/storage.md b/docs/src/protocol/account/storage.md similarity index 100% rename from docs/src/account/storage.md rename to docs/src/protocol/account/storage.md diff --git a/docs/src/asset.md b/docs/src/protocol/asset.md similarity index 100% rename from docs/src/asset.md rename to docs/src/protocol/asset.md diff --git a/docs/src/blockchain.md b/docs/src/protocol/blockchain.md similarity index 100% rename from docs/src/blockchain.md rename to docs/src/protocol/blockchain.md diff --git a/docs/src/fees.md b/docs/src/protocol/fees.md similarity index 100% rename from docs/src/fees.md rename to docs/src/protocol/fees.md diff --git a/docs/src/img/account/account-definition.png b/docs/src/protocol/img/account/account-definition.png similarity index 100% rename from docs/src/img/account/account-definition.png rename to docs/src/protocol/img/account/account-definition.png diff --git a/docs/src/img/asset/asset-issuance.png b/docs/src/protocol/img/asset/asset-issuance.png similarity index 100% rename from docs/src/img/asset/asset-issuance.png rename to docs/src/protocol/img/asset/asset-issuance.png diff --git a/docs/src/img/asset/asset-storage.png b/docs/src/protocol/img/asset/asset-storage.png similarity index 100% rename from docs/src/img/asset/asset-storage.png rename to docs/src/protocol/img/asset/asset-storage.png diff --git a/docs/src/img/blockchain/batching.png b/docs/src/protocol/img/blockchain/batching.png similarity index 100% rename from docs/src/img/blockchain/batching.png rename to docs/src/protocol/img/blockchain/batching.png diff --git a/docs/src/img/blockchain/block.png b/docs/src/protocol/img/blockchain/block.png similarity index 100% rename from docs/src/img/blockchain/block.png rename to docs/src/protocol/img/blockchain/block.png diff --git a/docs/src/img/blockchain/execution.png b/docs/src/protocol/img/blockchain/execution.png similarity index 100% rename from docs/src/img/blockchain/execution.png rename to docs/src/protocol/img/blockchain/execution.png diff --git a/docs/src/img/miden-architecture-core-concepts.gif b/docs/src/protocol/img/miden-architecture-core-concepts.gif similarity index 100% rename from docs/src/img/miden-architecture-core-concepts.gif rename to docs/src/protocol/img/miden-architecture-core-concepts.gif diff --git a/docs/src/img/miden-architecture-state-progress.gif b/docs/src/protocol/img/miden-architecture-state-progress.gif similarity index 100% rename from docs/src/img/miden-architecture-state-progress.gif rename to docs/src/protocol/img/miden-architecture-state-progress.gif diff --git a/docs/src/img/network/Miden_node.png b/docs/src/protocol/img/network/Miden_node.png similarity index 100% rename from docs/src/img/network/Miden_node.png rename to docs/src/protocol/img/network/Miden_node.png diff --git a/docs/src/img/network/architecture-overview.png b/docs/src/protocol/img/network/architecture-overview.png similarity index 100% rename from docs/src/img/network/architecture-overview.png rename to docs/src/protocol/img/network/architecture-overview.png diff --git a/docs/src/img/note/note-life-cycle.png b/docs/src/protocol/img/note/note-life-cycle.png similarity index 100% rename from docs/src/img/note/note-life-cycle.png rename to docs/src/protocol/img/note/note-life-cycle.png diff --git a/docs/src/img/note/note.png b/docs/src/protocol/img/note/note.png similarity index 100% rename from docs/src/img/note/note.png rename to docs/src/protocol/img/note/note.png diff --git a/docs/src/img/note/nullifier.png b/docs/src/protocol/img/note/nullifier.png similarity index 100% rename from docs/src/img/note/nullifier.png rename to docs/src/protocol/img/note/nullifier.png diff --git a/docs/src/img/state/account-db.png b/docs/src/protocol/img/state/account-db.png similarity index 100% rename from docs/src/img/state/account-db.png rename to docs/src/protocol/img/state/account-db.png diff --git a/docs/src/img/state/amm-transactions.gif b/docs/src/protocol/img/state/amm-transactions.gif similarity index 100% rename from docs/src/img/state/amm-transactions.gif rename to docs/src/protocol/img/state/amm-transactions.gif diff --git a/docs/src/img/state/note-db.png b/docs/src/protocol/img/state/note-db.png similarity index 100% rename from docs/src/img/state/note-db.png rename to docs/src/protocol/img/state/note-db.png diff --git a/docs/src/img/state/nullifier-db.png b/docs/src/protocol/img/state/nullifier-db.png similarity index 100% rename from docs/src/img/state/nullifier-db.png rename to docs/src/protocol/img/state/nullifier-db.png diff --git a/docs/src/img/state/public-shared-state.png b/docs/src/protocol/img/state/public-shared-state.png similarity index 100% rename from docs/src/img/state/public-shared-state.png rename to docs/src/protocol/img/state/public-shared-state.png diff --git a/docs/src/img/state/state.png b/docs/src/protocol/img/state/state.png similarity index 100% rename from docs/src/img/state/state.png rename to docs/src/protocol/img/state/state.png diff --git a/docs/src/img/transaction/local-vs-network-transaction.png b/docs/src/protocol/img/transaction/local-vs-network-transaction.png similarity index 100% rename from docs/src/img/transaction/local-vs-network-transaction.png rename to docs/src/protocol/img/transaction/local-vs-network-transaction.png diff --git a/docs/src/img/transaction/memory-layout-kernel.png b/docs/src/protocol/img/transaction/memory-layout-kernel.png similarity index 100% rename from docs/src/img/transaction/memory-layout-kernel.png rename to docs/src/protocol/img/transaction/memory-layout-kernel.png diff --git a/docs/src/img/transaction/one-transfer-two-transactions.gif b/docs/src/protocol/img/transaction/one-transfer-two-transactions.gif similarity index 100% rename from docs/src/img/transaction/one-transfer-two-transactions.gif rename to docs/src/protocol/img/transaction/one-transfer-two-transactions.gif diff --git a/docs/src/img/transaction/transaction-contexts.png b/docs/src/protocol/img/transaction/transaction-contexts.png similarity index 100% rename from docs/src/img/transaction/transaction-contexts.png rename to docs/src/protocol/img/transaction/transaction-contexts.png diff --git a/docs/src/img/transaction/transaction-diagram.png b/docs/src/protocol/img/transaction/transaction-diagram.png similarity index 100% rename from docs/src/img/transaction/transaction-diagram.png rename to docs/src/protocol/img/transaction/transaction-diagram.png diff --git a/docs/src/img/transaction/transaction-execution-process.png b/docs/src/protocol/img/transaction/transaction-execution-process.png similarity index 100% rename from docs/src/img/transaction/transaction-execution-process.png rename to docs/src/protocol/img/transaction/transaction-execution-process.png diff --git a/docs/src/img/transaction/transaction-flow.png b/docs/src/protocol/img/transaction/transaction-flow.png similarity index 100% rename from docs/src/img/transaction/transaction-flow.png rename to docs/src/protocol/img/transaction/transaction-flow.png diff --git a/docs/src/img/transaction/transaction-program.png b/docs/src/protocol/img/transaction/transaction-program.png similarity index 100% rename from docs/src/img/transaction/transaction-program.png rename to docs/src/protocol/img/transaction/transaction-program.png diff --git a/docs/src/img/transaction/tx-overview.png b/docs/src/protocol/img/transaction/tx-overview.png similarity index 100% rename from docs/src/img/transaction/tx-overview.png rename to docs/src/protocol/img/transaction/tx-overview.png diff --git a/docs/src/index.md b/docs/src/protocol/index.md similarity index 73% rename from docs/src/index.md rename to docs/src/protocol/index.md index bf7c554b86..011f04f410 100644 --- a/docs/src/index.md +++ b/docs/src/protocol/index.md @@ -33,19 +33,19 @@ An [Account](account/index.md) can hold assets and define rules how assets can b ### Notes -A [Note](note) is a message that accounts send to each other. A note stores assets and a script that defines how the note can be consumed. The [note chapter](note) describes the design, the storage types, and the creation of a note. +A [Note](note.md) is a message that accounts send to each other. A note stores assets and a script that defines how the note can be consumed. The [note chapter](note.md) describes the design, the storage types, and the creation of a note. ### Assets -An [Asset](asset) can be fungible and non-fungible. They are stored in the owner's account itself or in a note. The [asset chapter](asset) describes asset issuance, customization, and storage. +An [Asset](asset.md) can be fungible and non-fungible. They are stored in the owner's account itself or in a note. The [asset chapter](asset.md) describes asset issuance, customization, and storage. ### Transactions -A [Transaction](transaction) describes the production and consumption of notes by a single account. +A [Transaction](transaction.md) describes the production and consumption of notes by a single account. Executing a transaction always results in a STARK proof. -The [transaction chapter](transaction) describes the transaction design and implementation, including an in-depth discussion of how transaction execution happens in the transaction kernel program. +The [transaction chapter](transaction.md) describes the transaction design and implementation, including an in-depth discussion of how transaction execution happens in the transaction kernel program. #### Accounts produce and consume notes to communicate @@ -59,11 +59,11 @@ Miden's state model captures the individual states of all accounts and notes, an ### State model -[State](state) describes everything that is the case at a certain point in time. Individual states of accounts or notes can be stored on-chain and off-chain. This chapter describes the three different state databases in Miden. +[State](state.md) describes everything that is the case at a certain point in time. Individual states of accounts or notes can be stored on-chain and off-chain. This chapter describes the three different state databases in Miden. ### Blockchain -The [Blockchain](blockchain) defines how state progresses as aggregated-state-updates in batches, blocks, and epochs. The [blockchain chapter](blockchain) describes the execution model and how blocks are built. +The [Blockchain](blockchain.md) defines how state progresses as aggregated-state-updates in batches, blocks, and epochs. The [blockchain chapter](blockchain.md) describes the execution model and how blocks are built. ##### Operators capture and progress state diff --git a/docs/src/note.md b/docs/src/protocol/note.md similarity index 100% rename from docs/src/note.md rename to docs/src/protocol/note.md diff --git a/docs/src/protocol_library.md b/docs/src/protocol/protocol_library.md similarity index 100% rename from docs/src/protocol_library.md rename to docs/src/protocol/protocol_library.md diff --git a/docs/src/state.md b/docs/src/protocol/state.md similarity index 100% rename from docs/src/state.md rename to docs/src/protocol/state.md diff --git a/docs/src/transaction.md b/docs/src/protocol/transaction.md similarity index 100% rename from docs/src/transaction.md rename to docs/src/protocol/transaction.md diff --git a/docs/src/standards/_category_.yml b/docs/src/standards/_category_.yml new file mode 100644 index 0000000000..dd17e412bc --- /dev/null +++ b/docs/src/standards/_category_.yml @@ -0,0 +1,4 @@ +label: "Standards" +# Determines where this documentation section appears relative to other sections on the main documentation page (which is the parent of this folder in the miden-docs repository) +position: 4 +collapsed: true diff --git a/docs/src/standards/index.md b/docs/src/standards/index.md new file mode 100644 index 0000000000..359e7726a6 --- /dev/null +++ b/docs/src/standards/index.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +title: Overview +--- + +# Miden Standards + +:::note +Placeholder. Documentation for the components published by `miden-standards` will land here in follow-up PRs. +::: + +The `miden-standards` crate provides reusable account components that build on top of the [protocol](../protocol/index.md) primitives. Examples include faucet components, authentication components, access-control components, and mint/burn policies.