docs: promote Client to top-level, add SDK docs, move CLI to Tools#199
docs: promote Client to top-level, add SDK docs, move CLI to Tools#199WiktorStarczewski wants to merge 10 commits intomainfrom
Conversation
- 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
…nsport), restore CLI get-started, delete orphaned PNGs
WiktorStarczewski
changed the title
|
Hey Wiktor, nice work on this! Love the mermaid styling and the Playground/Explorer pages. One thing — per the IA redesign we're working on in #178, I think Client should stay nested under Tools rather than being its own top-level sidebar section. Keeps everything developer-tooling related in one place. So the structure would be something like tools/clients/ (with rust, web, react under it), tools/cli/, and then playground + explorer alongside. I'll work on implementing those adjustments and push the changes. Also need to coordinate with #204 (repo renames) since it touches the same workflow files — will incorporate both. |
- Port mermaid diagram styles from PR #199: glassmorphic containers, branded colors, Manrope font for diagram text - Add mermaid theme config (neutral/dark) to docusaurus.config.ts - Create playground.md and explorer.md tool pages - Move testing, debugging, and pitfalls guides from tutorials/rust-compiler to new builder/guides/ section - Add Guides category to sidebar between Tutorials and Tools - Add Guides card to builder index page - Update rust-compiler index to link to new guide locations
- Port mermaid diagram styles from PR #199: glassmorphic containers, branded colors, Manrope font for diagram text - Add mermaid theme config (neutral/dark) to docusaurus.config.ts - Create playground.md and explorer.md tool pages - Move testing, debugging, and pitfalls guides from tutorials/rust-compiler to new builder/guides/ section - Add Guides category to sidebar between Tutorials and Tools - Add Guides card to builder index page - Update rust-compiler index to link to new guide locations
- Port mermaid diagram styles from PR #199: glassmorphic containers, branded colors, Manrope font for diagram text - Add mermaid theme config (neutral/dark) to docusaurus.config.ts - Create playground.md and explorer.md tool pages - Move testing, debugging, and pitfalls guides from tutorials/rust-compiler to new builder/guides/ section - Add Guides category to sidebar between Tutorials and Tools - Add Guides card to builder index page - Update rust-compiler index to link to new guide locations
|
Hey @WiktorStarczewski — thanks for all the work on this PR. I wanted to give you context on what's happened since. I've been working through the broader IA restructure (#178) and ended up implementing the changes in a series of PRs that overlap significantly with your work here:
The key architectural difference: per the #178 IA plan, we decided to nest client under Your miden-client PR (#1881) is the real substance — I just approved it. Once that lands on I think this PR can be closed once #223 merges, since the changes are covered across those three PRs. But wanted to check with you first — let me know if there's anything I missed or if you'd prefer to handle it differently. |
…ion (#223) - Port mermaid diagram styles from PR #199: glassmorphic containers, branded colors, Manrope font for diagram text - Add mermaid theme config (neutral/dark) to docusaurus.config.ts - Create playground.md and explorer.md tool pages - Move testing, debugging, and pitfalls guides from tutorials/rust-compiler to new builder/guides/ section - Add Guides category to sidebar between Tutorials and Tools - Add Guides card to builder index page - Update rust-compiler index to link to new guide locations
|
Ok cool, just a quick sanity check, did you think about at least renaming Tools to something else? ("Developer" maybe?) Asking since I was struggling to find the client doc and Tools wasn't obvious (even though I was sure it was there it took me some moments to locate it). Maybe it's just me. |
2 participants
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
nextfirst, then merge this PR. The deploy workflow pulls content from miden-clientnextbranch.Sidebar restructure
CI/CD updates
docs/builder/client/, CLI moved todocs/builder/tools/cli/Authored changes
sidebars.ts— Added Client category with autogenerated itemsdocs/builder/tools/playground.md— New page linking to playground.miden.iodocs/builder/tools/explorer.md— New page linking to explorer.testnet.miden.iodocs/builder/tools/index.md— Deleted (replaced by individual pages)docs/builder/index.md— Updated link from./toolsto./clientdocusaurus.config.ts— Config updatessrc/custom/— Mermaid diagram styling (branded colors, glassmorphic cards, Manrope font)Accompanying PR