Skip to content

docs: update engine example links for grouped framework folders#69

Merged
dhruvja merged 3 commits into
mainfrom
dhruvja/docs/update-example-links
Jul 8, 2026
Merged

docs: update engine example links for grouped framework folders#69
dhruvja merged 3 commits into
mainfrom
dhruvja/docs/update-example-links

Conversation

@dhruvja

@dhruvja dhruvja commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Merge order

Depends on magicblock-labs/magicblock-engine-examples#108.

Do not merge this PR until magicblock-labs/magicblock-engine-examples#108 is merged, otherwise these links will point to paths that do not exist on main.

Summary

Updates docs links to magicblock-engine-examples after the example repo refactor that groups implementations by use case and framework.

Changes

  • Update example links across English, Chinese, Japanese, and Korean docs/snippets.
  • Point framework-specific examples to their new paths, such as:
    • anchor-counter -> counter/anchor
    • rust-counter -> counter/native-rust
    • pinocchio-counter -> counter/pinocchio
    • magic-actions -> magic-actions/anchor
    • roll-dice -> roll-dice/anchor
  • Update visible path labels where they referenced moved folders.

Validation

  • git diff --check
  • Custom stale moved example URL scan
  • npx -y mintlify validate

Breaking changes

None for the docs site after magicblock-labs/magicblock-engine-examples#108 is merged. Before that dependency merges, the updated external links target paths that are not yet on the examples repo main branch.

Summary by CodeRabbit

  • Documentation
    • Updated many example and quick-access links across English, Chinese, Japanese, Korean, and general docs to point to more specific, current example locations.
    • Improved references for Anchor, Native Rust, Pinocchio, Magic Actions, private counter examples, and other templates so users reach the intended repository pages more easily.
    • Several payments, crank, and delegation-related links were also refreshed to match the latest example paths.

@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@dhruvja, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 41 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2b8967a3-d4c1-45bd-99d8-fdaa6cf4e3d4

📥 Commits

Reviewing files that changed from the base of the PR and between 3574c3f and d49e039.

📒 Files selected for processing (8)
  • cn/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • cn/pages/get-started/how-integrate-your-program/rust.mdx
  • jp/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • jp/pages/get-started/how-integrate-your-program/rust.mdx
  • ko/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • ko/pages/get-started/how-integrate-your-program/rust.mdx
  • pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • pages/get-started/how-integrate-your-program/rust.mdx

Walkthrough

This PR updates GitHub reference links throughout the documentation across English, Chinese, Japanese, and Korean locales. Card and inline hyperlinks are repointed from older top-level example repository paths (e.g., anchor-counter, rust-counter, magic-actions, private-counter, gachapon, roll-dice) to newer nested subdirectory paths (e.g., counter/anchor, counter/native-rust, magic-actions/anchor, private-counter/anchor, gachapon-example, roll-dice/anchor). No content, structure, or code logic changes were made; only href/URL values were modified.

Changes

Example repository link updates

Layer / File(s) Summary
Counter (Anchor/Native Rust) example links
*/get-started/how-integrate-your-program/anchor.mdx, */get-started/how-integrate-your-program/rust.mdx, */ephemeral-rollups-ers/how-to-guide/rust-tests.mdx, */ephemeral-rollups-ers/introduction/magic-router.mdx, */templates/counter.mdx, */snippets/quick-access-er*.mdx
Anchor and Native Rust counter example links updated to counter/anchor and counter/native-rust paths, replacing anchor-counter and rust-counter, across cn/jp/ko/en.
Magic Actions example links
*/ephemeral-rollups-ers/magic-actions/{client,implementation,overview,troubleshooting}.mdx, */ephemeral-rollups-ers/how-to-guide/quickstart.mdx
Reference implementation card links updated from the magic-actions root to magic-actions/anchor across all locales.
Delegation Actions example links
pages/ephemeral-rollups-ers/how-to-guide/{quickstart,rust-program}.mdx, pages/private-ephemeral-rollups-pers/how-to-guide/quickstart.mdx
“Delegation Actions Example” links updated to point to delegation-actions/anchor instead of delegation-actions.
Private-counter and access-control links
*/private-ephemeral-rollups-pers/how-to-guide/access-control.mdx, */snippets/quick-access-per.mdx
Reference and quick-access links updated to private-counter/anchor and private-counter/pinocchio across locales.
Ephemeral Accounts demo links
*/ephemeral-rollups-ers/introduction/ephemeral-accounts.mdx
Demo card link updated to the anchor/programs subdirectory across locales.
Payments example links
*/get-started/use-cases/payments.mdx
Payments example card link updated from dummy-token-transfer to spl-tokens/anchor across locales.
Other templates and quick-access snippet links
*/templates/{gachapon,onchain-dice,rock-paper-scissors}.mdx, */tools/crank/introduction.mdx, */snippets/{oncurve-delegation,quick-access-vrf}.mdx
Repository links updated for gachapon (→ gachapon-example), onchain-dice/rock-paper-scissors/crank (→ anchor subdirectory), and oncurve-delegation (→ client subdirectory), across locales.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • magicblock-labs/docs#52: Both PRs touch pages/tools/crank/introduction.mdx; the earlier PR introduced the crank docs page whose GitHub link is updated in this PR.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation link updates for the repository refactor.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dhruvja/docs/update-example-links

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
magicblock-42 🟢 Ready View Preview Jul 3, 2026, 9:06 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
magicblock 🟡 Building Jul 3, 2026, 9:01 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@jonasXchen jonasXchen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! we need to make sure the example and skills are synced

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@cn/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx`:
- Around line 31-39: The test-folder GitHub link in the Rust guide is pointing
to a directory using blob instead of tree. Update the href values in the Card
entries for the native Rust tests link and the Pinocchio tests link so they use
tree/main/... paths rather than blob/main/... paths, keeping the surrounding
Card markup unchanged.

In `@cn/pages/get-started/how-integrate-your-program/rust.mdx`:
- Around line 52-58: The GitHub links for the TypeScript test scripts point to a
directory, but the current hrefs use the blob view, which won’t open folders
correctly. Update the three tests link targets in the relevant MDX sections for
the Rust guide to use the tree view instead, and verify the Card entries labeled
for the tests still point to the same repository path via the correct directory
URL format.

In `@ko/pages/get-started/how-integrate-your-program/rust.mdx`:
- Around line 52-58: The GitHub links for the tests folder are using blob-style
URLs even though they point to a directory, so they will not open correctly;
update the relevant card/link entries in the Rust docs (including the ones
referenced by the tests folder links) to use tree-style URLs instead. Use the
existing link targets in the Rust page sections with the TypeScript/Rust
examples as the anchor points, and make sure every folder link to tests
consistently uses tree so the directory renders properly on GitHub.

In `@pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx`:
- Line 238: The card links in quickstart.mdx are pointing at the wrong example
path segment; update the href targets in the quickstart cards so they go to the
correct example directories under /magic-actions and /delegation-actions. Use
the existing card/link entries in the quickstart content to locate the affected
href values and replace the /anchor suffix with the intended directory names.

In `@pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx`:
- Around line 31-39: The Rust tests links in the how-to guide currently point to
paths that will 404 on the example repo’s main branch, so gate these hrefs
behind the `magicblock-engine-examples#108` refactor or update them to match the
current `rust-counter` and `pinocchio-counter` paths. Make the same
conditional/link fix in the related Card entries in this guide and in the
localized copies, using the existing link-rendering markup around the Rust tests
section.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a704b14e-eee3-4c7a-ab93-775118f902f5

📥 Commits

Reviewing files that changed from the base of the PR and between 4a5974a and 3574c3f.

📒 Files selected for processing (90)
  • cn/pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx
  • cn/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • cn/pages/ephemeral-rollups-ers/introduction/ephemeral-accounts.mdx
  • cn/pages/ephemeral-rollups-ers/introduction/magic-router.mdx
  • cn/pages/ephemeral-rollups-ers/magic-actions/client.mdx
  • cn/pages/ephemeral-rollups-ers/magic-actions/implementation.mdx
  • cn/pages/ephemeral-rollups-ers/magic-actions/overview.mdx
  • cn/pages/ephemeral-rollups-ers/magic-actions/troubleshooting.mdx
  • cn/pages/get-started/how-integrate-your-program/anchor.mdx
  • cn/pages/get-started/how-integrate-your-program/rust.mdx
  • cn/pages/get-started/use-cases/payments.mdx
  • cn/pages/private-ephemeral-rollups-pers/how-to-guide/access-control.mdx
  • cn/pages/templates/counter.mdx
  • cn/pages/templates/gachapon.mdx
  • cn/pages/templates/onchain-dice.mdx
  • cn/pages/templates/rock-paper-scissors.mdx
  • cn/pages/tools/crank/introduction.mdx
  • cn/snippets/oncurve-delegation.mdx
  • cn/snippets/quick-access-er-rust.mdx
  • cn/snippets/quick-access-er.mdx
  • cn/snippets/quick-access-per.mdx
  • cn/snippets/quick-access-vrf.mdx
  • jp/pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx
  • jp/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • jp/pages/ephemeral-rollups-ers/introduction/ephemeral-accounts.mdx
  • jp/pages/ephemeral-rollups-ers/introduction/magic-router.mdx
  • jp/pages/ephemeral-rollups-ers/magic-actions/client.mdx
  • jp/pages/ephemeral-rollups-ers/magic-actions/implementation.mdx
  • jp/pages/ephemeral-rollups-ers/magic-actions/overview.mdx
  • jp/pages/ephemeral-rollups-ers/magic-actions/troubleshooting.mdx
  • jp/pages/get-started/how-integrate-your-program/anchor.mdx
  • jp/pages/get-started/how-integrate-your-program/rust.mdx
  • jp/pages/get-started/use-cases/payments.mdx
  • jp/pages/private-ephemeral-rollups-pers/how-to-guide/access-control.mdx
  • jp/pages/templates/counter.mdx
  • jp/pages/templates/gachapon.mdx
  • jp/pages/templates/onchain-dice.mdx
  • jp/pages/templates/rock-paper-scissors.mdx
  • jp/pages/tools/crank/introduction.mdx
  • jp/snippets/oncurve-delegation.mdx
  • jp/snippets/quick-access-er-rust.mdx
  • jp/snippets/quick-access-er.mdx
  • jp/snippets/quick-access-per.mdx
  • jp/snippets/quick-access-vrf.mdx
  • ko/pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx
  • ko/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • ko/pages/ephemeral-rollups-ers/introduction/ephemeral-accounts.mdx
  • ko/pages/ephemeral-rollups-ers/introduction/magic-router.mdx
  • ko/pages/ephemeral-rollups-ers/magic-actions/client.mdx
  • ko/pages/ephemeral-rollups-ers/magic-actions/implementation.mdx
  • ko/pages/ephemeral-rollups-ers/magic-actions/overview.mdx
  • ko/pages/ephemeral-rollups-ers/magic-actions/troubleshooting.mdx
  • ko/pages/get-started/how-integrate-your-program/anchor.mdx
  • ko/pages/get-started/how-integrate-your-program/rust.mdx
  • ko/pages/get-started/use-cases/payments.mdx
  • ko/pages/private-ephemeral-rollups-pers/how-to-guide/access-control.mdx
  • ko/pages/templates/counter.mdx
  • ko/pages/templates/gachapon.mdx
  • ko/pages/templates/onchain-dice.mdx
  • ko/pages/templates/rock-paper-scissors.mdx
  • ko/pages/tools/crank/introduction.mdx
  • ko/snippets/oncurve-delegation.mdx
  • ko/snippets/quick-access-er-rust.mdx
  • ko/snippets/quick-access-er.mdx
  • ko/snippets/quick-access-per.mdx
  • ko/snippets/quick-access-vrf.mdx
  • pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx
  • pages/ephemeral-rollups-ers/how-to-guide/rust-program.mdx
  • pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx
  • pages/ephemeral-rollups-ers/introduction/ephemeral-accounts.mdx
  • pages/ephemeral-rollups-ers/introduction/magic-router.mdx
  • pages/ephemeral-rollups-ers/magic-actions/client.mdx
  • pages/ephemeral-rollups-ers/magic-actions/implementation.mdx
  • pages/ephemeral-rollups-ers/magic-actions/overview.mdx
  • pages/ephemeral-rollups-ers/magic-actions/troubleshooting.mdx
  • pages/get-started/how-integrate-your-program/anchor.mdx
  • pages/get-started/how-integrate-your-program/rust.mdx
  • pages/get-started/use-cases/payments.mdx
  • pages/private-ephemeral-rollups-pers/how-to-guide/access-control.mdx
  • pages/private-ephemeral-rollups-pers/how-to-guide/quickstart.mdx
  • pages/templates/counter.mdx
  • pages/templates/gachapon.mdx
  • pages/templates/onchain-dice.mdx
  • pages/templates/rock-paper-scissors.mdx
  • pages/tools/crank/introduction.mdx
  • snippets/oncurve-delegation.mdx
  • snippets/quick-access-er-rust.mdx
  • snippets/quick-access-er.mdx
  • snippets/quick-access-per.mdx
  • snippets/quick-access-vrf.mdx

Comment thread cn/pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx Outdated
Comment thread cn/pages/get-started/how-integrate-your-program/rust.mdx Outdated
Comment thread ko/pages/get-started/how-integrate-your-program/rust.mdx Outdated
Comment thread pages/ephemeral-rollups-ers/how-to-guide/quickstart.mdx
Comment thread pages/ephemeral-rollups-ers/how-to-guide/rust-tests.mdx Outdated
@dhruvja dhruvja merged commit 13872ad into main Jul 8, 2026
4 checks passed
@dhruvja dhruvja deleted the dhruvja/docs/update-example-links branch July 8, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants