refactor: group examples by use case and framework#108
Conversation
|
Important Review skippedToo many files! This PR contains 527 files, which is 377 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (67)
📒 Files selected for processing (527)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
…p-examples-by-framework
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
jonasXchen
left a comment
There was a problem hiding this comment.
lgtm! we need to make sure that docs and skills are synced!
|
The CI is failing since the paths have been updated. The solution would be to merge this to main and then update the paths on the vercel. |
…p-examples-by-framework # Conflicts: # README.md # dummy-token-transfer/Cargo.toml # dummy-token-transfer/anchor/Anchor.toml # dummy-token-transfer/anchor/Cargo.lock # dummy-token-transfer/anchor/Cargo.toml # dummy-token-transfer/anchor/README.md # dummy-token-transfer/anchor/package-lock.json # dummy-token-transfer/anchor/package.json # dummy-token-transfer/anchor/programs/dummy-transfer/Cargo.toml # dummy-token-transfer/anchor/programs/dummy-transfer/src/lib.rs # dummy-token-transfer/anchor/tests/dummy-transfer-local.ts # dummy-token-transfer/anchor/tests/dummy-transfer.ts # dummy-token-transfer/anchor/tsconfig.json # dummy-token-transfer/anchor/yarn.lock # dummy-token-transfer/package.json # dummy-token-transfer/programs/dummy-transfer/Cargo.toml # ephemeral-account-chats/anchor/.prettierignore # oracle-priced-purchase/Cargo.toml # oracle-priced-purchase/package.json # oracle-priced-purchase/programs/oracle-priced-purchase/Cargo.toml
## 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. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Closes: #106
Summary
Refactors the examples repo so each top-level folder represents a use case, with framework-specific implementations nested underneath.
Examples:
counter/anchorcounter/pinocchiocounter/native-rustprivate-counter/anchorprivate-counter/pinocchioroll-dice/anchorroll-dice/pinocchioChanges
anchor-counter,pinocchio-counter, andpinocchio-roll-dice.00-LEGACY_EXAMPLES,private-payments,binary-prediction, andoracle-priced-purchaseunchanged.Follow-Up
After this merges, update links in the docs repo that still point to the old flat example paths.
Testing
FAIL_FAST=1 bash scripts/test-locally.shbash -n scripts/projects.sh scripts/test-example.sh scripts/test-locally.sh scripts/check-prettier.sh scripts/update-sdk-versions.shgit diff --checkpackage.jsonfiles