docs: add midenup page · flip tutorials ingest back to main#257
Merged
Conversation
midenup is the Miden toolchain installer — the unified 'miden' entry
point that manages Miden VM, compiler (midenc + cargo-miden), client,
stdlib, and transaction kernel versions as a single release channel.
Until now it had no dedicated page on docs.miden.xyz; it was only
referenced in passing from installation and node-setup pages.
Add builder/tools/midenup.md with the same CardGrid + Callout pattern
as the rest of the Tools section (playground.md, network.md):
- Install (cargo install + midenup init)
- Components it manages (VM / midenc + cargo-miden / client / stdlib
/ transaction kernel)
- Toolchain management (install, set, override, show, uninstall)
- 'miden' entry-point alias table (new, build, account, faucet, send,
simulate, …)
- Related links to Installation, CLI basics, Network
Surface it on the Tools landing — bump the Environments CardGrid from
cols={2} to cols={3} so midenup sits alongside Playground and Network
('Toolchain + environments' section header).
Mirror into versioned_docs/version-0.14 + versioned_sidebars so the
default root route (which currently serves v0.14) shows midenup too —
it existed well before v0.14 so the snapshot should document it.
0xMiden/tutorials#186 merged upstream at 2026-04-23 10:11 UTC (merge commit 71cc533). The PR branch (kbg/chore/v14-migration) we pinned both the snapshot manifest and the deploy workflow to is now superseded by main. - .release/release-manifest.yml: tutorials: refs/pull/186/head → refs/heads/main - .github/workflows/deploy-docs.yml: DEFAULT_TUTORIALS_REF: kbg/chore/v14-migration → main Verified by re-cloning tutorials @ main, running the aggregate step, and building — setup_guide.md + all recipe content present, full build exits [SUCCESS] with the same 10 broken-link warnings (no regressions).
Previously the secondary hero CTA linked to the midenup GitHub repo (external). Now that the docs have a dedicated midenup page, repoint the CTA there — in-docs content explains install + usage, and users stay on-site for the deeper material. Flip the arrow glyph from ↗ (external) to → (internal) to match.
Keep the page title and in-body references to 'midenup' lowercase (that's the command / crate name), but render it as 'Midenup' in the sidebar so it reads as a proper nav item alongside 'Playground' and 'Network'. sidebar_label frontmatter is the scoped override.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two small post-v0.14-cut updates.
1. New midenup toolchain page
midenup has been a real part of the ecosystem for a while (
cargo install midenup && midenup init→ unified `miden` entry point delegating to VM, midenc, cargo-miden, client, stdlib, transaction kernel), but docs.miden.xyz only referenced it in passing from installation/node-setup. Add a dedicated page at/builder/tools/midenup:cargo install midenup && midenup init)midenentry-point alias table (miden new,miden build,miden faucet,miden send,miden simulate, …)Surfaced on the Tools landing — bumped the Environments CardGrid to
cols={3}so midenup sits alongside Playground and Network.Mirrored into
versioned_docs/version-0.14/+versioned_sidebars/so the default (root = v0.14) routes show it too — midenup predates v0.14, no reason to hide it from the current snapshot.2. Flip tutorials ingest back to main
0xMiden/tutorials#186merged upstream at 2026-04-23 10:11 UTC (merge commit71cc533). The PR branch (kbg/chore/v14-migration) we pinned in PR #256 is now superseded bymain— the merged state is identical..release/release-manifest.yml:tutorials: refs/pull/186/head → refs/heads/main.github/workflows/deploy-docs.yml:DEFAULT_TUTORIALS_REF: kbg/chore/v14-migration → mainVerification
Local
npm run buildwith tutorials freshly re-cloned frommain(merge commit 71cc533) and all other vendors onnext(matches deploy-docs.yml CI state):Both
/builder/tools/midenup/(default = v0.14) and/next/builder/tools/midenup/build successfully.Test plan
mainpost-merge exits green.docs.miden.xyz/builder/tools/midenuprenders the new page.docs.miden.xyz/builder/tools/Environments grid shows 3 cards (midenup / Playground / Network).docs.miden.xyz/next/builder/tutorials/recipes/web/setup_guidestill resolves (content comes from tutorials main, which now contains PR fix: move note-types.md from develop/ to smart-contracts/notes/ #186).