docs: restructure client docs, expand Rust library, add React/TS SDKs by WiktorStarczewski · Pull Request #1881 · 0xMiden/miden-client

WiktorStarczewski · 2026-03-10T00:23:10Z

Summary

Major restructure of the client documentation in docs/external/src/:

Structural changes

CLI docs moved from rust-client/cli/ to top-level cli/ — these are now synced to Tools/CLI in miden-docs (no longer nested under the Rust client)
CLI Getting Started restored under cli/get-started/ with full tutorials (create account, public P2P, private P2P)
CLI Config moved into cli/get-started/ as the first subsection
Rust client rewritten to focus exclusively on the Rust library (no CLI references)
Rust library expanded from a single library.md to a multi-page library/ directory with 11 pages
Client index renamed to "Design" — serves as the architectural overview

New Rust library pages

library/index.md — Client initialization, API overview, dependencies
library/accounts.md — Retrieving accounts, checking balance
library/new-accounts.md — Creating wallets (private/public/mutable), faucets
library/compile.md — CodeBuilder API: compile account components, transaction scripts, note scripts, library linking
library/import.md — Importing accounts by ID, from objects, importing notes from NoteFile variants
library/export.md — Exporting notes and accounts
library/new-transactions.md — Pay-to-id, consuming, minting, swaps, remote prover, custom transactions
library/transactions.md — Transaction history, statuses, output notes
library/notes.md — Listing, filtering, consumable notes
library/tags.md — Note tag management (add/remove/list, tag sources, sync behavior)
library/note-transport.md — Sending/fetching private notes, pagination, complete example
library/sync.md — State synchronization, when to sync, sync height

Rust client docs rewritten

rust-client/index.md — Library overview (no CLI mentions)
rust-client/install-and-run.md — Cargo.toml dependency (not cargo install), feature flags, version 0.14
rust-client/features.md — Library capabilities with code snippets
rust-client/get-started/ — All tutorials rewritten with Rust library API instead of CLI commands
rust-client/examples.md — Hub page linking to all library reference pages + prover fallback example

Other changes

Client index (index.md): Updated SDK table, removed "and CLI" from Rust description
Common errors: Documented 9 additional errors, capitalized "Miden Client"
Orphaned PNGs deleted: Removed 10 unused screenshots from img/get-started/
CLI fixes: Fixed sidebar-position → sidebar_position typos, !!! note → :::note Docusaurus syntax, fixed broken GitHub links to relative paths
Capitalization: "Miden Client" consistently capitalized across all docs

Accompanying PR

miden-docs: docs: promote Client to top-level, add SDK docs, move CLI to Tools docs#199

Move 12 reference pages into library/ subfolder, add get-started tutorials (create account, public/private P2P transfers, mock client), and create structural pages (install, features, design, api-docs, library index). Delete dead rpc_client.md stub. Rewrite index.md as slim overview.

…ages - Client index: add four-layer SDK architecture diagram and table (rust-sdk → wasm-bridge → ts-sdk / react-sdk) - web-client/design: focus on ts-sdk design, move high-level architecture to parent index - web-client/examples: rewrite as navigation hub linking to tutorials and library reference pages - web-client/features: swap position with get-started to match Rust order

Reorganize by category (connection, account, note, transaction, store) and add errors sourced from the codebase's ErrorHint implementations.

- Add full React SDK docs section (react-client/) with overview, install, features, design, get-started tutorials, and library reference - Document MultiSignerProvider and useMultiSigner for multi-signer dapps - Fix mermaid diagrams using \n instead of <br/> in web-client and react-client - Link React SDK from parent client index page

This reverts commit a7cc917.

- @miden-sdk/miden-sdk → @miden-sdk/ts-sdk in all web-client imports/installs - @miden-sdk/miden-sdk → @miden-sdk/wasm-bridge in react-client peer dep refs - @miden-sdk/react → @miden-sdk/react-sdk in all react-client imports/installs - Fix signer package names to match PR #1872 actuals - Update GitHub links from miden-client to ts-sdk/wasm-bridge repos

…cs for library - Move CLI docs from rust-client/cli/ to top-level cli/ (will be synced under Tools) - Rewrite Rust client docs to focus on library API (no CLI references) - Rewrite get-started tutorials with Rust library API instead of CLI commands - Fix broken links and frontmatter typos (sidebar-position → sidebar_position) - Fix non-Docusaurus admonition syntax in CLI docs - Update version references from 0.11 to 0.14 - Update top-level index to remove CLI from Rust SDK description

…nsport), restore CLI get-started, delete orphaned PNGs

igamigo · 2026-03-10T20:27:11Z

+# Miden Client

-The Miden client currently has three main components:
+The Miden Client SDK is organized as a layered stack. The Rust core is the single source of truth for all client logic. Browser-facing SDKs build on top of it through a WASM bridge layer, giving TypeScript and React developers native access to the full protocol without needing a Rust toolchain.


This is a bit confusing. Should all components be mentioned here? It feels like each repo (once the split is done) should contain its own information and then a higher-level component (miden-docs) should mention each separately

Or maybe this is for the current repo split, but in that case I don't see how this should mention these names (eg, wasm-bridge should be web-client)

Well, first of all, we pull the docs from current client repo so they can be maintained in the client, if we move them to the docs repo, then they have to be maintained there (which is fine, but against our current strategy).

This already includes the repo split, so the WASM bridge is the correct name.

But if this includes the split, why would this repo need to maintain the docs for other repos then? Should those docs not be added to their own? cc @Keinberger

Address PR review feedback from igamigo.

BrianSeong99

LGTM — docs restructure aligns with our miden-docs CI changes (tools/clients + tools/cli split). All checks pass.

Keinberger

Hey @WiktorStarczewski, thanks a lot for this restructure, this has been overdue for some time and is really valuable!

I let my agent run through the PR to find potentially incorrect API references, package names, etc. so that we make sure everything is accurate against next. See the inline comments below.

Thanks!

- Fix Rust client API: use submit_new_transaction(), correct build_pay_to_id/build_consume_notes/build_swap signatures, replace nonexistent get_account()/get_accounts()/export_note()/ import_note_from_file()/get_latest_epoch_block() with real API - Fix npm package names: @miden-sdk/react-sdk -> @miden-sdk/react, @miden-sdk/ts-sdk -> @miden-sdk/miden-sdk, @miden-sdk/wasm-bridge -> @miden-sdk/miden-sdk - Fix environment="BETA" -> "PRODUCTION" inconsistency in signers.md

Keinberger

Hey @WiktorStarczewski, almost everything looks solid, thanks! I left two inline comments on the remaining issues found by my agents.

Everything else looks correct, thanks!

I think two small fixes and this is ready to merge. Thanks!

Keinberger · 2026-04-10T10:52:34Z

+```rust
+// Get consumable notes for an account
+let consumable = client.get_consumable_notes(Some(account_id)).await?;
+let notes: Vec<_> = consumable.into_iter().map(|n| n.note).collect();


get_consumable_notes returns Vec<(InputNoteRecord, Vec<NoteConsumability>)> a tuple. The iterator variable n is a (InputNoteRecord, Vec<NoteConsumability>), so .note doesn't exist and this won't compile. You'll need to destructure the tuple and convert the record, something like:

let notes: Vec<Note> = consumable .into_iter() .map(|(record, _)| record.try_into()) .collect::<Result<_, _>>()?;

Keinberger · 2026-04-10T10:52:34Z

+Retrieve an output note and convert it to a `NoteFile` for export:
+
+```rust
+use miden_client::note::NoteExportType;


Three issues here:

use miden_client::note::NoteExportType: NoteExportType is not exported from the note module. The correct import is use miden_client::store::NoteExportType.

Line 20: NoteExportType::Full doesn't exist. The correct variant is NoteExportType::NoteWithProof.

Lines 26-29: The table lists Id, Details, Full -- these should be NoteId, NoteDetails, NoteWithProof to match the actual enum.

WiktorStarczewski added 9 commits March 9, 2026 23:55

docs: add frontmatter to common-errors, document 9 additional errors

d7e7486

Reorganize by category (connection, account, note, transaction, store) and add errors sourced from the codebase's ErrorHint implementations.

docs: add spacing around mermaid diagrams

a7cc917

Revert "docs: add spacing around mermaid diagrams"

b53f791

This reverts commit a7cc917.

docs: redesign Zustand store and signer diagrams for readability

2b3d281

docs: refine React design page copy for consumer audience

a1418f3

WiktorStarczewski requested review from BrianSeong99 and Keinberger March 10, 2026 00:23

WiktorStarczewski added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label Mar 10, 2026

WiktorStarczewski added 2 commits March 10, 2026 01:27

fix(docs): broken link to draft mock.md in examples page

2484943

WiktorStarczewski mentioned this pull request Mar 10, 2026

docs: promote Client to top-level, add SDK docs, move CLI to Tools 0xMiden/docs#199

Closed

docs: capitalize Miden Client, fix admonition syntax

0bb1c63

WiktorStarczewski requested a review from igamigo March 10, 2026 01:34

docs: add Rust library pages (compile, tags, import, export, note-tra…

b463143

…nsport), restore CLI get-started, delete orphaned PNGs

WiktorStarczewski changed the title ~~docs: restructure web-client docs, add React SDK documentation~~ docs: restructure client docs, expand Rust library, add React/TS SDKs Mar 10, 2026

docs: fix Rust core label in mermaid diagrams to @miden-sdk/rust-sdk

5b5b16f

igamigo reviewed Mar 10, 2026

View reviewed changes

docs: use account_reader() in get-started tutorial

4d24f53

Address PR review feedback from igamigo.

BrianSeong99 approved these changes Mar 21, 2026

View reviewed changes

Keinberger requested changes Mar 24, 2026

View reviewed changes

WiktorStarczewski added 2 commits April 10, 2026 10:17

Merge origin/next into wiktor-newdocs

007cac2

Keinberger reviewed Apr 10, 2026

View reviewed changes

Dominik1999 mentioned this pull request Apr 14, 2026

Meta: Documentation for v0.15 #2018

Open

6 tasks

Conversation

WiktorStarczewski commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Structural changes

New Rust library pages

Rust client docs rewritten

Other changes

Accompanying PR

Uh oh!

igamigo Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

igamigo Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

WiktorStarczewski Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

igamigo Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BrianSeong99 left a comment

Choose a reason for hiding this comment

Uh oh!

Keinberger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Keinberger left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Keinberger Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Keinberger Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WiktorStarczewski commented Mar 10, 2026 •

edited

Loading

igamigo Mar 24, 2026 •

edited

Loading

Keinberger left a comment •

edited

Loading

Keinberger Apr 10, 2026 •

edited

Loading

Keinberger Apr 10, 2026 •

edited

Loading