fix(sidebars): drop recipes/web/setup_guide until PR #186 merges#255
Merged
Conversation
The sidebar enumeration landed in PR #254 references 'builder/tutorials/recipes/web/setup_guide', but that file only exists on 0xMiden/tutorials#186 (kbg/chore/v14-migration branch) — which has not merged into tutorials main yet. deploy-docs.yml ingests tutorials from its main branch for the live /next/ deploy, so every push-to-main build since PR #254 has crashed in loadVersion with: Invalid sidebar file at "sidebars.ts". These sidebar document ids do not exist: - builder/tutorials/recipes/web/setup_guide Remove the entry with a TODO to re-add after PR #186 merges. The setup_guide page will re-appear on the v0.14 release branch (which explicitly pins tutorials to the PR #186 ref).
6 tasks
BrianSeong99
added a commit
that referenced
this pull request
Apr 23, 2026
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
PR #254 enumerated the new
recipes/web/*entries in the sidebar, includingsetup_guide— but that file only exists on0xMiden/tutorials#186(kbg/chore/v14-migration). That PR has not merged into tutorialsmainyet, anddeploy-docs.ymlingests tutorials frommain, so every push-to-main build since #254 has aborted in Docusaurus's sidebar validator:See failing run:
24820901856.Fix
Remove the single offending line from
sidebars.tswith an inline TODO to re-add once0xMiden/tutorials#186lands upstream. Thesetup_guidepage will still appear in the v0.14 release branch (which explicitly pins the tutorials ingest torefs/pull/186/head).Verification
Reproduced the CI failure locally by ingesting tutorials from
main:Applied the fix, re-ran the same ingest + build:
[SUCCESS] Generated static files in "build", exit 0.Follow-up
Re-add
"builder/tutorials/recipes/web/setup_guide"in a separate one-line PR once0xMiden/tutorials#186merges into tutorialsmain. The v0.14 release branch (brian/v0.14-release, in progress) will carry the entry since it ingests PR #186's tree directly.