chore(release): cut v0.14 docs snapshot#256
Merged
Merged
Conversation
Pages still referenced the old Tutorials IA (`/builder/tutorials/ rust-compiler/` + `/core-concepts/miden-base/`) that PR #254 retired. Repoint to current canonical paths: - builder/index: ./tutorials/rust-compiler → ./tutorials - get-started/accounts, your-first-smart-contract/test: ../tutorials/rust-compiler/ → ../tutorials/ - your-first-smart-contract/create: /core-concepts/miden-base/ → /core-concepts/protocol/ (v0.13 naming → v0.14 naming) - tutorials/helpers/{pitfalls,testing}: ../tutorials/miden-bank/ → ../miden-bank/ (fix doubled segment) - tutorials/miden-bank/index: ../rust-compiler/{testing,debugging, pitfalls} → ../helpers/{testing,debugging,pitfalls} - tutorials/miden-bank/index: ./NN-name → ./name (Docusaurus's default numberPrefixParser strips the numeric prefix from doc IDs/URLs) - footer Tutorials link: /builder/tutorials/rust-compiler → /builder/tutorials Local npm run build: 931 broken-link warnings collapsed to 10 (6 of which are frozen in versioned_docs/version-0.13, 4 upstream-owned).
Two related sidebar changes needed for the v0.14 cut: 1. Manually enumerate miden-bank's Part 0–8 pages under a category (with the landing as category.link). Previously the sidebar had only "builder/tutorials/miden-bank/index", which left the part pages unlisted and their internal ./project-setup-style links broken. Per project convention, prefer explicit enumeration over autogenerated. Doc IDs use the stripped names (numberPrefixParser collapses 00-project-setup.md → project-setup). 2. Re-add "builder/tutorials/recipes/web/setup_guide" that was temporarily removed on main (PR #255) to unstick the deploy. This branch pins the tutorials ingest to 0xMiden/tutorials#186, which includes setup_guide, so the doc id resolves here.
.release/release-manifest.yml — bump version to 0.14, next_version to 0.15, and pin source refs: protocol: v0.14.4 node: v0.14.9 miden-client: v0.14.4 tutorials: refs/pull/186/head # kbg/chore/v14-migration miden-vm: v0.22.1 compiler: v0.8.1 deploy-docs.yml — temporarily point DEFAULT_TUTORIALS_REF at the tutorials PR #186 branch (kbg/chore/v14-migration) so the live /next/ ingest matches what v0.14 snapshot was cut from. Otherwise main would again fail sidebar validation on recipes/web/setup_guide. TODO inline: flip back to 'main' once 0xMiden/tutorials#186 merges upstream.
docs:version 0.14 output — versioned_docs/version-0.14/ (~26 MB) and versioned_sidebars/version-0.14-sidebars.json. versions.json grows to [0.14, 0.13, 0.12, 0.11]; 0.14 becomes the current (default) version. Source refs per the release manifest: - protocol v0.14.4 - node v0.14.9 - miden-client v0.14.4 - tutorials refs/pull/186/head (kbg/chore/v14-migration) - miden-vm v0.22.1 - compiler v0.8.1 Build: 931 broken-link warnings (pre-cut, dominated by footer 710×2 for /core-concepts/protocol + /core-concepts/node which didn't exist in v0.13) collapsed to 10, of which 6 live in the frozen v0.13 snapshot and 4 are owned upstream (recipes/rust-client path collisions + a vendor absolute link).
Two sidebar/content cleanups that should ship with the v0.14 cut: 1. The Clients sidebar section only enumerated TypeScript and React — the Rust client's ~15 ingested pages (install/features/design, get-started, CLI, examples, api-docs, …) existed under tools/clients/rust-client/ but were orphaned from the sidebar. Add a 'Rust' category under Clients, ordered Rust → TypeScript → React so the default flow follows what most tutorials use. 2. docs/builder/index.md had an info Callout titled 'v0.13 · v0.14 in development' explaining that v0.13 is the current stable release. With v0.14 now promoted to current, that text is stale — remove the Callout entirely. Update the VersionNote default stableVersion v0.13 → v0.14 for the same reason. Re-cut versioned_docs/version-0.14 + versioned_sidebars/ version-0.14-sidebars.json to reflect these (only the Rust category add is a structural sidebar change; the callout removal is a content delete).
The tools/clients/index.md landing was still on the legacy prose-and-
table layout (markdown table + 'Navigate via the sidebar' pointer +
bulleted How-the-surfaces-relate list). Replace with three CardGrids
to match the Build / Smart Contracts / Tools / Tutorials landings:
- ## SDKs — cols={3} linking to Rust / TypeScript / React surfaces
- ## Pick a surface — cols={2} positioning guide (library vs CLI vs
Web SDK vs React SDK) without links — it's a how-to-choose block
- ## Shared topics — cols={2} linking to Common errors + Tutorials
Mirror the change in versioned_docs/version-0.14/ so the v0.14 cut
ships with the new layout from day one.
debugging.md exists on miden-client v0.14.4 (captured in the v0.14 snapshot's versioned_sidebars/version-0.14-sidebars.json) but was deleted from the miden-client 'next' branch. Since deploy-docs.yml ingests tutorials + client docs from 'next' for the live /next/ build, leaving the id in the current sidebars.ts would reproduce exactly the setup_guide-style failure we hit in PR #255 — 'Invalid sidebar file: doc id does not exist'. Remove from the current sidebar with an inline note. The v0.14 snapshot sidebar is unchanged — readers browsing /v0.14/ still see the debugging page. Verified by simulating the CI ingest locally: cloned every vendor at the exact refs deploy-docs.yml uses (protocol/node/miden-client/ miden-vm/compiler @ next, tutorials @ kbg/chore/v14-migration), ran the workflow's aggregate step, then npm run build → [SUCCESS] exit 0, 10 broken-link warnings (no new ones).
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
Cuts the v0.14 documentation snapshot. v0.14 becomes the default (root) version; v0.13 moves to
/0.13/archive. Based on the latest stable patch releases per source repo.Source refs (per .release/release-manifest.yml)
v0.14.4v0.14.9v0.14.4v0.22.1v0.8.1refs/pull/186/head(kbg/chore/v14-migration)next_version: "0.15".miden-crypto is not a docs ingest source; v0.24.0 is on crates.io but miden-vm v0.22.1 still pins 0.23 internally, so the v0.14-era migration guide text (
miden-crypto = "0.23") is correct for this cut.Commits
docs: fix dead links on locally-authored pages— retire lingering/builder/tutorials/rust-compiler/and/core-concepts/miden-base/references; fix footer Tutorials link; strip numeric prefixes from./00-project-setup-style links (Docusaurus's default numberPrefixParser).docs(sidebars): enumerate miden-bank children + restore setup_guide— explicit enumeration of the miden-bank category (with stripped-prefix doc IDs); re-addrecipes/web/setup_guidethat was temporarily removed on main in fix(sidebars): drop recipes/web/setup_guide until PR #186 merges #255.chore(release): set up v0.14 manifest + deploy ingest pin— bump.release/release-manifest.ymlto 0.14 / next 0.15 with the refs above; temporarily pointdeploy-docs.ymlDEFAULT_TUTORIALS_REF atkbg/chore/v14-migrationso the live/next/ingest matches the snapshot (inline TODO to flip back tomainonce0xMiden/tutorials#186merges).chore(release): cut v0.14 docs snapshot—versioned_docs/version-0.14/(26 MB),versioned_sidebars/version-0.14-sidebars.json,versions.json→[0.14, 0.13, 0.12, 0.11].Verification
Local
npm run build(ingest done with the same refs as the manifest):[SUCCESS], all 6 vendor checkouts clean, Local Search builds 4 indexes (0.11 / 0.12 / 0.13 / 0.14), 0.14 promoted to default version.versioned_docs/version-0.13/snapshot — unfixable without editing the v0.13 archive, which we won't do.../miden_node_setup.mdpath regressed after therust-client → recipes/rustrename in0xMiden/tutorials#186; a miden-vm docs absolute link/user_docs/libcore/word). These should be fixed upstream in their source repos.#dyncall-block,#stdstarkmod,#stdsysvm; protocolnote#inputs).Test plan
maingoes green after merge (we'll watch Actions the same way we did fix(sidebars): drop recipes/web/setup_guide until PR #186 merges #255).docs.miden.xyz/serves v0.14 content at the root (not v0.13).docs.miden.xyz/0.13/still reachable as the archived version.docs.miden.xyz/next/renders with v0.14-matching vendor content (becauseDEFAULT_TUTORIALS_REFis pinned to the PR branch)./builder/tutorials/landing loads and links to miden-bank's Part 0–8 cards work (i.e../project-setup,./account-components, …,./complete-flows— not the numeric-prefix versions).Follow-ups (not blocking)
DEFAULT_TUTORIALS_REFback tomainindeploy-docs.ymlonce0xMiden/tutorials#186merges upstream.0xMiden/tutorials#186for the two remaining doc-content link bugs (../miden_node_setup.mdafter the rename; the known miden-bankmiden-bank/X-segment-doubling andinstallation.md#anchorissues that also trip broken anchors).0xMiden/miden-vmfor the absolute/user_docs/libcore/worddead link.