docs: fix outdated repository URLs across tutorials - #218
Open
wolfgang1211 wants to merge 1 commit into
Open
Conversation
The tutorials repository was renamed from `0xMiden/miden-tutorials` to `0xMiden/tutorials`, and the React SDK moved out of the old `0xMiden/miden-client` repository (now `0xMiden/rust-sdk`) into `0xMiden/web-sdk`. The docs still referenced the old locations. - Replace 33 `github.com/0xMiden/miden-tutorials` links with `github.com/0xMiden/tutorials` across 24 tutorial pages, and update the clone snippet in the Miden Bank index so `cd` matches the cloned directory name. - Point the React wallet tutorial's "Running the Example" section at `0xMiden/web-sdk`, where `packages/react-sdk/examples/wallet` actually lives. The previous path 404s after the redirect, and the commands are replaced with the pnpm workflow documented in that example's README. - Point the React SDK reference link at `0xMiden/web-sdk` for the same reason.
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.
What
Two GitHub repositories referenced throughout the tutorials have moved, and the docs still point at their old locations:
0xMiden/miden-tutorials0xMiden/tutorials(this repo)0xMiden/miden-client->packages/react-sdk0xMiden/web-sdk->packages/react-sdkThe first is a rename, so those links still resolve through GitHub's redirect - but they read as a different repository, which is confusing in pages that say "this repository", and they break the copy-paste
git clone+cdsnippet in the Miden Bank index.The second is genuinely broken.
0xMiden/miden-clientnow redirects to0xMiden/rust-sdk, which has nopackages/directory onmain, sohttps://github.com/0xMiden/miden-client/tree/main/packages/react-sdk404s and the React wallet tutorial's clone-and-run instructions cannot work. The React SDK and itsexamples/walletapp live in0xMiden/web-sdk.Changes
github.com/0xMiden/miden-tutorialslinks withgithub.com/0xMiden/tutorialsacross 24 tutorial pages, and updated the link text[miden-tutorials]->[tutorials]where the repo name was the label.docs/src/miden-bank/index.mdso thecdmatches the directorygit cloneactually creates.0xMiden/web-sdk, and replaced theyarn install/yarn devcommands with the pnpm workflow documented in that example's own README (the workspace build step pluspnpm install --ignore-workspace, since the example sits outside the pnpm workspace).0xMiden/web-sdk.Verification
blob/main/...andtree/main/...path linked into this repo was checked against the repo tree - all 11 resolve.packages/react-sdk/examples/walletconfirmed present in0xMiden/web-sdk@mainand absent from0xMiden/rust-sdk@main.prettier@3.8.4 --check "**/*.md"passes (same version the Format Markdown workflow pins).cargo test --docis unaffected.Note on overlap
#203 also touches the Miden React SDK Reference line, repointing it at
https://docs.miden.xyz/builder/tools/clients/react-sdk/instead. Both fixes are valid - if you'd rather take #203's version of that one line, I'm happy to drop that hunk. The Running the Example block is not covered by #203 or #213.