Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .github/workflows/cut-versions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ jobs:

# Clean directories that will be re-synced (v0.4 nested paths)
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
rm -rf docs/builder/tools/client
rm -rf docs/builder/tools/client docs/builder/client docs/builder/tools/cli
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)

# Core Concepts docs → docs/core-concepts/*
Expand Down Expand Up @@ -188,9 +188,15 @@ jobs:
fi

if [ -d "vendor/miden-client/docs/external/src" ]; then
mkdir -p docs/builder/tools/client
cp -r vendor/miden-client/docs/external/src/* docs/builder/tools/client/
echo "Synced miden-client → docs/builder/tools/client"
mkdir -p docs/builder/client
cp -r vendor/miden-client/docs/external/src/* docs/builder/client/
echo "Synced miden-client → docs/builder/client"

# Move CLI directory to Tools section
if [ -d "docs/builder/client/cli" ]; then
mv docs/builder/client/cli docs/builder/tools/cli
echo "Moved CLI docs → docs/builder/tools/cli"
fi
fi

echo "Content aggregation complete. Final docs structure:"
Expand Down Expand Up @@ -219,7 +225,8 @@ jobs:
rm -rf docs/core-concepts/miden-vm
rm -rf docs/core-concepts/miden-node
rm -rf docs/core-concepts/compiler
rm -rf docs/builder/tools/client
rm -rf docs/builder/client
rm -rf docs/builder/tools/cli
# Note: tutorials live in docs/builder/tutorials/ (authored content, not cleaned)

- name: Commit snapshots
Expand Down
14 changes: 10 additions & 4 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ jobs:

# Clean directories that will be re-synced (v0.4 nested paths)
rm -rf docs/core-concepts/miden-base docs/core-concepts/miden-vm docs/core-concepts/miden-node docs/core-concepts/compiler
rm -rf docs/builder/tools/client
rm -rf docs/builder/tools/client docs/builder/client docs/builder/tools/cli
# Note: docs/builder/tutorials is NOT fully cleaned to preserve local tutorials (e.g. miden-bank)

# Core Concepts docs → docs/core-concepts/*
Expand Down Expand Up @@ -184,9 +184,15 @@ jobs:
fi

if [ -d "vendor/miden-client/docs/external/src" ]; then
mkdir -p docs/builder/tools/client
cp -r vendor/miden-client/docs/external/src/* docs/builder/tools/client/
echo "Synced miden-client → docs/builder/tools/client"
mkdir -p docs/builder/client
cp -r vendor/miden-client/docs/external/src/* docs/builder/client/
echo "Synced miden-client → docs/builder/client"

# Move CLI directory to Tools section
if [ -d "docs/builder/client/cli" ]; then
mv docs/builder/client/cli docs/builder/tools/cli
echo "Moved CLI docs → docs/builder/tools/cli"
fi
fi

echo "Content aggregation complete. Final docs structure:"
Expand Down
6 changes: 3 additions & 3 deletions docs/builder/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ import DocCard from '@theme/DocCard';
<DocCard
item={{
type: 'link',
href: './tools',
label: 'Tools',
description: 'Miden Client libraries, CLI, and developer tooling.',
href: './client',
label: 'Client SDKs',
description: 'Rust, TypeScript, and React SDKs for building on Miden.',
}}
/>
</div>
Expand Down
10 changes: 10 additions & 0 deletions docs/builder/tools/explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Explorer
sidebar_position: 4
---

# Miden Explorer

The Miden Explorer is a block explorer for the Miden network. Use it to inspect blocks, transactions, accounts, and notes on testnet and devnet.

**[Open the Explorer](https://explorer.testnet.miden.io/)**
31 changes: 0 additions & 31 deletions docs/builder/tools/index.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/builder/tools/playground.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Playground
sidebar_position: 3
---

# Miden Playground

The Miden Playground is an interactive browser-based environment for writing, compiling, and executing Miden assembly programs.

Use it to experiment with Miden VM instructions, test note scripts, and prototype account code — without installing any tooling locally.

**[Open the Playground](https://playground.miden.io/)**
7 changes: 7 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,13 @@ const config: Config = {
{ name: "twitter:card", content: "summary_large_image" },
{ name: "twitter:site", content: "@0xMiden" },
],
mermaid: {
theme: { light: "neutral", dark: "dark" },
options: {
fontFamily: '"Manrope", ui-sans-serif, system-ui, sans-serif',
fontSize: 14,
},
},
colorMode: {
defaultMode: "light",
disableSwitch: false,
Expand Down
9 changes: 7 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
*
* - builderSidebar: Usage-focused docs (tutorials, guides, reference)
* Canonical source: docs/builder/ (get-started, smart-contracts, etc.)
* Ingested content: docs/builder/tutorials/, docs/builder/client/
* Ingested content: docs/builder/tutorials/, docs/builder/client/, docs/builder/tools/cli/
*
* - coreConceptsSidebar: Architecture/internals (protocol, VM, proving)
* Canonical source: Landing page in docs/core-concepts/index.md
Expand Down Expand Up @@ -51,9 +51,14 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Tools",
link: { type: "doc", id: "builder/tools/index" },
items: [{ type: "autogenerated", dirName: "builder/tools" }],
},
{
type: "category",
label: "Client",
link: { type: "doc", id: "builder/client/index" },
items: [{ type: "autogenerated", dirName: "builder/client" }],
},

// ── SOLUTIONS
{
Expand Down
Loading