Skip to content

docs: restructure docs/src/ for new builder docs information architecture #165

@BrianSeong99

Description

@BrianSeong99

Context

We're redesigning the docs/builder/ information architecture in miden-docs#178. The simplified approach keeps this repo's structure mostly unchanged — just add miden-bank.

What Changed From Previous Plan

Previous plan Simplified Why
Restructure docs/src/ into tutorials/, examples/, guides/ Keep existing structure as-is Tutorials repo stays self-contained
Combine rust-client + web-client into tabbed pages Keep separate rust-client/ and web-client/ dirs No content restructuring needed
Move testing guides here from miden-docs Guides stay in miden-docs Already authored there, tool-oriented content
3 targeted cp -r commands on miden-docs side 1 cp -r (same as today, just new path) Minimal CI change

Current Structure (unchanged)

docs/src/
├── _category_.yml
├── index.md
├── miden_node_setup.md
├── rust-client/          ← 14 standalone tutorials (unchanged)
├── web-client/           ← 9 standalone tutorials (unchanged)
├── components/           ← shared code (unchanged)
├── img/                  ← images (unchanged)
├── lib.rs                ← (unchanged)
└── theme/                ← (unchanged)

What's New: Add miden-bank/

The miden-bank 9-part tutorial currently lives in miden-docs at docs/builder/develop/tutorials/rust-compiler/miden-bank/. It should move here so all tutorial content has a single source repo.

Files to add

docs/src/
└── miden-bank/                          NEW — moved from miden-docs
    ├── _category_.json
    ├── index.md
    ├── 00-project-setup.md
    ├── 01-account-components.md
    ├── 02-constants-constraints.md
    ├── 03-asset-management.md
    ├── 04-note-scripts.md
    ├── 05-cross-component-calls.md
    ├── 06-transaction-scripts.md
    ├── 07-output-notes.md
    └── 08-complete-flows.md

That's it. One directory added, no restructuring.

CI Ingestion (miden-docs side)

The miden-docs CI will change from:

cp -r vendor/miden-tutorials/docs/src/* docs/builder/develop/tutorials/

To:

cp -r vendor/miden-tutorials/docs/src/* docs/builder/tutorials/

One path change. Everything in docs/src/ gets ingested into docs/builder/tutorials/ as-is.

Coordination

  • miden-docs issue: miden-docs#178
  • This repo just needs to add miden-bank — no blocking dependency on miden-docs changes
  • The components/, img/, lib.rs, and theme/ directories are unchanged

Implementation Steps

  1. Copy miden-bank files from miden-docs (docs/builder/develop/tutorials/rust-compiler/miden-bank/) into this repo at docs/src/miden-bank/
  2. Update any internal links in miden-bank files (relative paths may change)
  3. Verify the tutorial builds correctly
  4. PR and merge

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions