Skip to content

Commit 437f2ff

Browse files
authored
Merge pull request #188 from 0xMiden/brian/sidebar-sections-flatten-develop
docs: add sidebar section headers and flatten develop/
2 parents c42aa3f + 5c4eec3 commit 437f2ff

File tree

101 files changed

+131
-103
lines changed

Some content is hidden

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

101 files changed

+131
-103
lines changed

.github/workflows/cut-versions.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55
# v0.4 Information Architecture:
66
# - Core Concepts docs (miden-base, miden-vm, compiler, miden-node) → docs/core-concepts/
7-
# - Builder docs (miden-tutorials, miden-client) → docs/builder/develop/tutorials/, docs/builder/tools/client/
7+
# - Builder docs (miden-tutorials, miden-client) → docs/builder/tutorials/, docs/builder/tools/client/
88
#
99
# Workflow responsibilities:
1010
# 1. Check out external repos at pinned refs
@@ -152,7 +152,7 @@ jobs:
152152
# Clean directories that will be re-synced (v0.4 nested paths)
153153
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
155-
# Note: docs/builder/develop/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
155+
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
156156
157157
# Core Concepts docs → docs/core-concepts/*
158158
if [ -d "vendor/miden-base/docs/src" ]; then
@@ -180,11 +180,11 @@ jobs:
180180
fi
181181
182182
# Builder docs → docs/builder/*
183-
# Sync miden-tutorials into develop/tutorials (local tutorials are preserved)
183+
# Sync miden-tutorials into tutorials (local tutorials are preserved)
184184
if [ -d "vendor/miden-tutorials/docs/src" ]; then
185-
mkdir -p docs/builder/develop/tutorials
186-
cp -r vendor/miden-tutorials/docs/src/* docs/builder/develop/tutorials/
187-
echo "Synced miden-tutorials → docs/builder/develop/tutorials"
185+
mkdir -p docs/builder/tutorials
186+
cp -r vendor/miden-tutorials/docs/src/* docs/builder/tutorials/
187+
echo "Synced miden-tutorials → docs/builder/tutorials"
188188
fi
189189
190190
if [ -d "vendor/miden-client/docs/external/src" ]; then
@@ -200,7 +200,7 @@ jobs:
200200
echo "Builder subdirs:"
201201
ls -la docs/builder/ || true
202202
echo "Tutorials subdirs:"
203-
ls -la docs/builder/develop/tutorials/ || true
203+
ls -la docs/builder/tutorials/ || true
204204
205205
- name: Cut version snapshot
206206
run: |
@@ -220,7 +220,7 @@ jobs:
220220
rm -rf docs/core-concepts/miden-node
221221
rm -rf docs/core-concepts/compiler
222222
rm -rf docs/builder/tools/client
223-
# Note: tutorials live in docs/builder/develop/tutorials/ (authored content, not cleaned)
223+
# Note: tutorials live in docs/builder/tutorials/ (authored content, not cleaned)
224224
225225
- name: Commit snapshots
226226
run: |

.github/workflows/deploy-docs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ jobs:
148148
# Clean directories that will be re-synced (v0.4 nested paths)
149149
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
151-
# Note: docs/builder/develop/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
151+
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)
152152
153153
# Core Concepts docs → docs/core-concepts/*
154154
if [ -d "vendor/miden-base/docs/src" ]; then
@@ -176,11 +176,11 @@ jobs:
176176
fi
177177
178178
# Builder docs → docs/builder/*
179-
# Sync miden-tutorials into develop/tutorials (local tutorials are preserved)
179+
# Sync miden-tutorials into tutorials (local tutorials are preserved)
180180
if [ -d "vendor/miden-tutorials/docs/src" ]; then
181-
mkdir -p docs/builder/develop/tutorials
182-
cp -r vendor/miden-tutorials/docs/src/* docs/builder/develop/tutorials/
183-
echo "Synced miden-tutorials → docs/builder/develop/tutorials"
181+
mkdir -p docs/builder/tutorials
182+
cp -r vendor/miden-tutorials/docs/src/* docs/builder/tutorials/
183+
echo "Synced miden-tutorials → docs/builder/tutorials"
184184
fi
185185
186186
if [ -d "vendor/miden-client/docs/external/src" ]; then
@@ -196,7 +196,7 @@ jobs:
196196
echo "Builder subdirs:"
197197
ls -la docs/builder/ || true
198198
echo "Tutorials subdirs:"
199-
ls -la docs/builder/develop/tutorials/ || true
199+
ls -la docs/builder/tutorials/ || true
200200
201201
- name: Install deps
202202
run: npm install --frozen-lockfile

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ 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:
184184
- Core Concepts docs → `docs/core-concepts/miden-base/`, `miden-vm/`, `compiler/`, `miden-node/`
185-
- Builder docs → `docs/builder/develop/tutorials/`, `docs/builder/tools/client/`
185+
- Builder docs → `docs/builder/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`
188188

docs/builder/develop/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/builder/develop/index.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/builder/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ import DocCard from '@theme/DocCard';
7070
<DocCard
7171
item={{
7272
type: 'link',
73-
href: './develop',
73+
href: './tutorials/rust-compiler',
7474
label: 'Tutorials',
7575
description: 'Step-by-step guides for building applications on Miden.',
7676
}}

docs/builder/quick-start/accounts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ npm run dev
158158
```
159159

160160
:::tip
161-
For detailed frontend setup guidance, see the [Tutorials section](../develop/tutorials/rust-compiler/).
161+
For detailed frontend setup guidance, see the [Tutorials section](../tutorials/rust-compiler/).
162162
:::
163163

164164
## Creating Accounts Programmatically

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Congratulations! You've successfully completed the Miden smart contract quick st
299299

300300
To deepen your knowledge, we recommend exploring the following resources:
301301

302-
- Visit the [Tutorials section](../../develop/tutorials/rust-compiler/) for detailed, hands-on guides on topics such as contract interactions, advanced storage, custom note scripting, and integrating with external applications.
302+
- Visit the [Tutorials section](../../tutorials/rust-compiler/) for detailed, hands-on guides on topics such as contract interactions, advanced storage, custom note scripting, and integrating with external applications.
303303
- For in-depth technical explanations of core concepts, consult the [Core Concepts section](../../../core-concepts/) of the documentation. Here you'll find comprehensive information on Miden's architecture, account model, transaction lifecycle, and the underlying zero-knowledge technology that powers the network.
304304

305305
The foundational patterns and concepts you've practiced in this Quick Start will enable you to build complex, privacy-preserving applications on the Miden network. Continue with the resources above to take your development further!
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Miden Smart Contracts",
2+
"label": "Smart Contracts",
33
"position": 3
44
}

docs/builder/smart-contracts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Reference documentation for building Miden smart contracts in Rust
66

77
# Miden Smart Contracts
88

9-
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](../develop/tutorials/rust-compiler/miden-bank/).
9+
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/).
1010

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

0 commit comments

Comments
 (0)