Skip to content

Commit 7707490

Browse files
committed
Merge remote-tracking branch 'origin/main' into brian/issue-177-sdk-fixes
# Conflicts: # static/llms.txt # static/skill.md
2 parents 3c6ef00 + 5b11e5d commit 7707490

375 files changed

Lines changed: 95 additions & 90 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/cut-versions.yml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# This workflow ingests external repos and creates versioned snapshots.
44
#
55
# v0.4 Information Architecture:
6-
# - Design docs (miden-base, miden-vm, compiler, miden-node) → docs/design/
6+
# - Core Concepts docs (miden-base, miden-vm, compiler, miden-node) → docs/core-concepts/
77
# - Builder docs (miden-tutorials, miden-client) → docs/builder/develop/tutorials/, docs/builder/tools/client/
88
#
99
# Workflow responsibilities:
@@ -150,33 +150,33 @@ jobs:
150150
echo "Aggregating vendor docs into v0.4 IA structure..."
151151
152152
# Clean directories that will be re-synced (v0.4 nested paths)
153-
rm -rf docs/design/miden-base docs/design/miden-vm docs/design/miden-node docs/design/compiler
153+
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
154154
rm -rf docs/builder/tools/client
155155
# Note: docs/builder/develop/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
156156
157-
# Design docs → docs/design/*
157+
# Core Concepts docs → docs/core-concepts/*
158158
if [ -d "vendor/miden-base/docs/src" ]; then
159-
mkdir -p docs/design/miden-base
160-
cp -r vendor/miden-base/docs/src/* docs/design/miden-base/
161-
echo "Synced miden-base → docs/design/miden-base"
159+
mkdir -p docs/core-concepts/miden-base
160+
cp -r vendor/miden-base/docs/src/* docs/core-concepts/miden-base/
161+
echo "Synced miden-base → docs/core-concepts/miden-base"
162162
fi
163163
164164
if [ -d "vendor/miden-vm/docs/src" ]; then
165-
mkdir -p docs/design/miden-vm
166-
cp -r vendor/miden-vm/docs/src/* docs/design/miden-vm/
167-
echo "Synced miden-vm → docs/design/miden-vm"
165+
mkdir -p docs/core-concepts/miden-vm
166+
cp -r vendor/miden-vm/docs/src/* docs/core-concepts/miden-vm/
167+
echo "Synced miden-vm → docs/core-concepts/miden-vm"
168168
fi
169169
170170
if [ -d "vendor/miden-node/docs/external/src" ]; then
171-
mkdir -p docs/design/miden-node
172-
cp -r vendor/miden-node/docs/external/src/* docs/design/miden-node/
173-
echo "Synced miden-node → docs/design/miden-node"
171+
mkdir -p docs/core-concepts/miden-node
172+
cp -r vendor/miden-node/docs/external/src/* docs/core-concepts/miden-node/
173+
echo "Synced miden-node → docs/core-concepts/miden-node"
174174
fi
175175
176176
if [ -d "vendor/compiler/docs/external/src" ]; then
177-
mkdir -p docs/design/compiler
178-
cp -r vendor/compiler/docs/external/src/* docs/design/compiler/
179-
echo "Synced compiler → docs/design/compiler"
177+
mkdir -p docs/core-concepts/compiler
178+
cp -r vendor/compiler/docs/external/src/* docs/core-concepts/compiler/
179+
echo "Synced compiler → docs/core-concepts/compiler"
180180
fi
181181
182182
# Builder docs → docs/builder/*
@@ -195,8 +195,8 @@ jobs:
195195
196196
echo "Content aggregation complete. Final docs structure:"
197197
ls -la docs/
198-
echo "Design subdirs:"
199-
ls -la docs/design/ || true
198+
echo "Core Concepts subdirs:"
199+
ls -la docs/core-concepts/ || true
200200
echo "Builder subdirs:"
201201
ls -la docs/builder/ || true
202202
echo "Tutorials subdirs:"
@@ -209,16 +209,16 @@ jobs:
209209
npm run docusaurus -- docs:version "$VERSION"
210210
211211
# CRITICAL: Clean up docs/ to maintain canonical-source architecture
212-
# docs/ must only contain authored content (builder/, design/ landing pages)
212+
# docs/ must only contain authored content (builder/, core-concepts/ landing pages)
213213
# All ingested content lives in versioned_docs/ after versioning
214214
- name: Clean up (delete vendor and ingested docs)
215215
run: |
216216
rm -rf vendor
217217
# Clean v0.4 nested paths
218-
rm -rf docs/design/miden-base
219-
rm -rf docs/design/miden-vm
220-
rm -rf docs/design/miden-node
221-
rm -rf docs/design/compiler
218+
rm -rf docs/core-concepts/miden-base
219+
rm -rf docs/core-concepts/miden-vm
220+
rm -rf docs/core-concepts/miden-node
221+
rm -rf docs/core-concepts/compiler
222222
rm -rf docs/builder/tools/client
223223
# Note: tutorials live in docs/builder/develop/tutorials/ (authored content, not cleaned)
224224

.github/workflows/deploy-docs.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -138,41 +138,41 @@ jobs:
138138

139139
# ============================================================
140140
# v0.4 IA: Aggregate into nested structure
141-
# - Design docs (miden-base, miden-vm, compiler, miden-node) → docs/design/
141+
# - Core Concepts docs (miden-base, miden-vm, compiler, miden-node) → docs/core-concepts/
142142
# - Builder docs (miden-tutorials, miden-client) → docs/builder/
143143
# ============================================================
144144
- name: Aggregate docs into single docs tree
145145
run: |
146146
echo "Aggregating vendor docs into v0.4 IA structure..."
147147
148148
# Clean directories that will be re-synced (v0.4 nested paths)
149-
rm -rf docs/design/miden-base docs/design/miden-vm docs/design/miden-node docs/design/compiler
149+
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
150150
rm -rf docs/builder/tools/client
151151
# Note: docs/builder/develop/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
152152
153-
# Design docs → docs/design/*
153+
# Core Concepts docs → docs/core-concepts/*
154154
if [ -d "vendor/miden-base/docs/src" ]; then
155-
mkdir -p docs/design/miden-base
156-
cp -r vendor/miden-base/docs/src/* docs/design/miden-base/
157-
echo "Synced miden-base → docs/design/miden-base"
155+
mkdir -p docs/core-concepts/miden-base
156+
cp -r vendor/miden-base/docs/src/* docs/core-concepts/miden-base/
157+
echo "Synced miden-base → docs/core-concepts/miden-base"
158158
fi
159159
160160
if [ -d "vendor/miden-vm/docs/src" ]; then
161-
mkdir -p docs/design/miden-vm
162-
cp -r vendor/miden-vm/docs/src/* docs/design/miden-vm/
163-
echo "Synced miden-vm → docs/design/miden-vm"
161+
mkdir -p docs/core-concepts/miden-vm
162+
cp -r vendor/miden-vm/docs/src/* docs/core-concepts/miden-vm/
163+
echo "Synced miden-vm → docs/core-concepts/miden-vm"
164164
fi
165165
166166
if [ -d "vendor/miden-node/docs/external/src" ]; then
167-
mkdir -p docs/design/miden-node
168-
cp -r vendor/miden-node/docs/external/src/* docs/design/miden-node/
169-
echo "Synced miden-node → docs/design/miden-node"
167+
mkdir -p docs/core-concepts/miden-node
168+
cp -r vendor/miden-node/docs/external/src/* docs/core-concepts/miden-node/
169+
echo "Synced miden-node → docs/core-concepts/miden-node"
170170
fi
171171
172172
if [ -d "vendor/compiler/docs/external/src" ]; then
173-
mkdir -p docs/design/compiler
174-
cp -r vendor/compiler/docs/external/src/* docs/design/compiler/
175-
echo "Synced compiler → docs/design/compiler"
173+
mkdir -p docs/core-concepts/compiler
174+
cp -r vendor/compiler/docs/external/src/* docs/core-concepts/compiler/
175+
echo "Synced compiler → docs/core-concepts/compiler"
176176
fi
177177
178178
# Builder docs → docs/builder/*
@@ -191,8 +191,8 @@ jobs:
191191
192192
echo "Content aggregation complete. Final docs structure:"
193193
ls -la docs/
194-
echo "Design subdirs:"
195-
ls -la docs/design/ || true
194+
echo "Core Concepts subdirs:"
195+
ls -la docs/core-concepts/ || true
196196
echo "Builder subdirs:"
197197
ls -la docs/builder/ || true
198198
echo "Tutorials subdirs:"

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Docusaurus v3 documentation site for the Miden ecosystem. Deployed at docs.miden.xyz.
55

66
## Key Directories
7-
- `docs/` — current docs (design, builder/)
7+
- `docs/` — current docs (core-concepts, builder/)
88
- `docs/builder/` — developer-facing: tools, develop, quick-start, smart-contracts, migration
9-
- `docs/design/` — protocol design docs
9+
- `docs/core-concepts/` — protocol design docs
1010
- `versioned_docs/` — pinned version snapshots
1111
- `src/` — custom React components, pages, CSS
1212
- `static/` — images, assets

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ flowchart TD
2323
BuilderRef["builder/reference/"]
2424
BuilderFAQ["builder/faq.md"]
2525
BuilderGlossary["builder/glossary.md"]
26-
DesignLanding["design/index.md"]
26+
DesignLanding["core-concepts/index.md"]
2727
Intro["intro.md"]
2828
end
2929
@@ -88,7 +88,7 @@ flowchart TD
8888
| Category | Location | Source | Example |
8989
|----------|----------|--------|---------|
9090
| **Authored** | `docs/builder/` | Written in this repo | `docs/builder/quick-start/`, `docs/builder/faq.md` |
91-
| **Ingested (live)** | `docs/design/`, `docs/builder/` | External repos @ next | `docs/design/miden-base/`, `docs/builder/tutorials/` |
91+
| **Ingested (live)** | `docs/core-concepts/`, `docs/builder/` | External repos @ next | `docs/core-concepts/miden-base/`, `docs/builder/tutorials/` |
9292
| **Ingested (versioned)** | `versioned_docs/` | External repos @ release tags | `versioned_docs/version-0.12/miden-base/` |
9393
| **Snapshots** | `versioned_docs/` | Frozen via `docs:version` | All versioned content |
9494

@@ -181,7 +181,7 @@ Deployment is **automatic** on push to `main`.
181181
The `.github/workflows/deploy-docs.yml` workflow:
182182
1. Checks out this repository and all external source repos
183183
2. Ingests external docs into v0.4 IA structure:
184-
- Design docs → `docs/design/miden-base/`, `miden-vm/`, `compiler/`, `miden-node/`
184+
- Core Concepts docs → `docs/core-concepts/miden-base/`, `miden-vm/`, `compiler/`, `miden-node/`
185185
- Builder docs → `docs/builder/develop/tutorials/`, `docs/builder/tools/client/`
186186
3. Runs `npm run build` to generate the static site
187187
4. Deploys to GitHub Pages at `docs.miden.xyz`
@@ -209,7 +209,7 @@ The build uses:
209209
### ❌ DON'T
210210

211211
- **Never** manually copy external content into `docs/` (use CI/CD ingestion)
212-
- **Never** create root-level `docs/miden-base/`, `docs/miden-vm/`, etc. (use nested paths in `docs/design/`)
212+
- **Never** create root-level `docs/miden-base/`, `docs/miden-vm/`, etc. (use nested paths in `docs/core-concepts/`)
213213
- **Never** edit `versioned_docs/` directly (snapshots are immutable)
214214
- **Never** create a root-level `docs/quick-start/` (Quick Start lives in `docs/builder/`)
215215

docs/builder/quick-start/your-first-smart-contract/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ impl IncrementNote {
228228

229229
The struct definition (`IncrementNote`) provides a named type for the note script. Unlike account contracts, note scripts don't store persistent data — the struct serves as the entry point container.
230230

231-
Learn more about [note scripts in the Miden documentation](/miden-base/note/).
231+
Learn more about [note scripts in the Miden documentation](/core-concepts/miden-base/note/).
232232

233233
#### The Note Script Function
234234

docs/builder/quick-start/your-first-smart-contract/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The integration folder serves two essential functions in Miden development:
4242
Think of the scripts in `src/bin/` as Miden's equivalent to [**Foundry scripts**](https://getfoundry.sh/guides/scripting-with-solidity). These are executable Rust binaries that handle all your contract interactions:
4343

4444
- **Contract Deployment**: Scripts that create and deploy accounts to the network
45-
- **Function/Procedure Calls**: Scripts that interact with deployed contracts through notes or [transaction scripts](/miden-base/transaction#transaction-lifecycle)
45+
- **Function/Procedure Calls**: Scripts that interact with deployed contracts through notes or [transaction scripts](/core-concepts/miden-base/transaction#transaction-lifecycle)
4646
- **State Queries**: Scripts that read contract state from the network
4747
- **Operations**: Scripts for contract upgrades, configuration changes, etc.
4848

docs/builder/smart-contracts/accounts/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Every account has four parts:
2121
| **Vault** | The fungible and non-fungible assets the account holds |
2222
| **Nonce** | A counter that increments exactly once per state change, providing replay protection |
2323

24-
The network doesn't store the full account state. Instead, it stores cryptographic commitments — hashes of the code, storage, and vault (see [account design](/design/miden-base/account/)). Only the account owner (or a public account's observers) sees the actual data.
24+
The network doesn't store the full account state. Instead, it stores cryptographic commitments — hashes of the code, storage, and vault (see [account design](/core-concepts/miden-base/account/)). Only the account owner (or a public account's observers) sees the actual data.
2525

2626
## Components, not contracts
2727

docs/builder/smart-contracts/notes/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Transaction 1 (Sender) Transaction 2 (Recipient)
4848

4949
**Transaction 1**: The sender's account creates an output note, attaches assets to it, and the note is published (either on-chain or kept private).
5050

51-
**Transaction 2**: The recipient discovers the note, consumes it in their own transaction, the note script runs and verifies the consumer is authorized, and assets transfer into the recipient's vault. A **nullifier** is recorded to prevent the same note from being consumed again (see [note design](/design/miden-base/note)).
51+
**Transaction 2**: The recipient discovers the note, consumes it in their own transaction, the note script runs and verifies the consumer is authorized, and assets transfer into the recipient's vault. A **nullifier** is recorded to prevent the same note from being consumed again (see [note design](/core-concepts/miden-base/note)).
5252

5353
This separation is what enables privacy and parallelism — the two transactions are independent and unlinkable from the network's perspective.
5454

docs/builder/smart-contracts/transactions/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "Transactions are Miden's execution unit — they consume input not
88

99
Transactions are the execution unit in Miden. Every state change — transferring assets, updating storage, minting tokens — happens inside a transaction. Each transaction runs against a single account, consumes zero or more input notes, and produces zero or more output notes.
1010

11-
The critical difference from other blockchains: transactions execute locally on the user's machine, not on a shared VM. After execution, the Miden VM generates a zero-knowledge proof that the transaction was valid (see [transaction design](/design/miden-base/transaction)). Only this proof and the resulting state commitments are submitted to the network. The network never sees the transaction inputs, the account's private state, or the logic that ran.
11+
The critical difference from other blockchains: transactions execute locally on the user's machine, not on a shared VM. After execution, the Miden VM generates a zero-knowledge proof that the transaction was valid (see [transaction design](/core-concepts/miden-base/transaction)). Only this proof and the resulting state commitments are submitted to the network. The network never sees the transaction inputs, the account's private state, or the logic that ran.
1212

1313
## Anatomy of a transaction
1414

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Design",
2+
"label": "Core Concepts",
33
"position": 2,
44
"collapsible": false,
55
"collapsed": false

0 commit comments

Comments
 (0)