Skip to content

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

Open
WiktorStarczewski wants to merge 10 commits intomainfrom
wiktor-ts-react-docs
Open

docs: promote Client to top-level, add SDK docs, move CLI to Tools#199
WiktorStarczewski wants to merge 10 commits intomainfrom
wiktor-ts-react-docs

Conversation

@WiktorStarczewski
Copy link
Contributor

@WiktorStarczewski WiktorStarczewski commented Mar 10, 2026

Summary

Structural changes to the docs site to support the new Client SDK documentation. All content lives in miden-client#1881 and is synced by CI at build time — no external content is committed here.

Merge order: merge miden-client#1881 to next first, then merge this PR. The deploy workflow pulls content from miden-client next branch.

Sidebar restructure

  • Client promoted to top-level sidebar category (same level as Tools)
  • CLI moved from Client/Rust/CLI to Tools/CLI (CI moves it during sync)
  • Tools index page removed — replaced by individual Playground and Explorer pages

CI/CD updates

  • deploy-docs.yml: Updated sync targets — client docs to docs/builder/client/, CLI moved to docs/builder/tools/cli/
  • cut-versions.yml: Mirrored deploy-docs changes for version snapshots

Authored changes

  • sidebars.ts — Added Client category with autogenerated items
  • docs/builder/tools/playground.md — New page linking to playground.miden.io
  • docs/builder/tools/explorer.md — New page linking to explorer.testnet.miden.io
  • docs/builder/tools/index.md — Deleted (replaced by individual pages)
  • docs/builder/index.md — Updated link from ./tools to ./client
  • docusaurus.config.ts — Config updates
  • src/custom/ — Mermaid diagram styling (branded colors, glassmorphic cards, Manrope font)

Accompanying PR

- Add Client as top-level sidebar category (same level as Tools)
- Update deploy-docs.yml to sync client to builder/client/ and move CLI to builder/tools/cli/
- Update cut-versions.yml to match new sync paths
- Update tools/index.md to reference CLI instead of client subsection
- Sync restructured content from miden-client source repo
@WiktorStarczewski WiktorStarczewski changed the title docs: promote Client to top-level sidebar, move CLI under Tools docs: promote Client to top-level, add SDK docs, move CLI to Tools Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant