[mirror] docs: add example migrations guide#4
Open
yashwant86 wants to merge 30 commits intomm-base-3126from
Open
[mirror] docs: add example migrations guide#4yashwant86 wants to merge 30 commits intomm-base-3126from
yashwant86 wants to merge 30 commits intomm-base-3126from
Conversation
- Move Example Migrations to the top of the Migration Guides sidebar so the nav order matches the 'start with Example Migrations' pointer at the top of the react-rails and vite-rails guides. - Add a short qualifier to the second published example repo link so it has parity with the first (describes the underlying reference app). - Add the custom Rails React bridge lane to the 'Contribute an example' list so it matches the three migration categories earlier in the doc. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a direct `open an issue` link to the GitHub issue tracker in the `Contribute an example` section of `example-migrations.md` so readers unfamiliar with the repo don't need to hunt for the URL. Addresses PR shakacode#3126 review feedback on thread PRRT_kwDOAnNnU8577IAz. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Drop the duplicate `react-on-rails-migration-example` link from `docs/README.md`; it is now the first entry in the example-migrations page that the README already links to. - Drop the "legacy asset-pipeline React mount" bullet from the intro list in `example-migrations.md` so the four-stack list matches the three subsections under "Example categories". - Add a one-line pointer at the end of "How to use these examples" to the other migration guides (Webpack → Rspack, Babel → SWC, Rails 5 API-only, AngularJS, RSC) so readers know the broader sidebar set exists. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- correct RSC sidebar pointer: RSC migration guides live under
React on Rails Pro → React Server Components, not the top-level
Migration Guides sidebar
- add version baseline ("react-rails v3 → react_on_rails v13.4")
on the first published example repo so readers can calibrate
relevance without clicking through
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The Inertia framing paragraph was present twice in docs/oss/migrating/example-migrations.md — the second copy was missing the Compare with alternatives link and was redundant. Deletes the second copy so the intro flows straight into the This page tracks practical migration references sentence. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ons-docs * origin/main: chore: remove redundant --rsc-pro install generator flag (shakacode#3105) ci: warn (don't fail) on Bencher main regression (shakacode#3168) test: enable RSpec --profile to surface slowest package tests (shakacode#3176) fix(node-renderer): expose performance in VM context when supportModules (shakacode#3158) docs: remove stale immediate_hydration references (shakacode#3139) (shakacode#3159) docs: restore absolute URL for node-renderer testing example (shakacode#3179) Bump Rspack dependencies to v2 (^2.0.0-0) (shakacode#3084) chore: remove obsolete webpack <5.106.0 pin (shakacode#3175) Move Node Renderer entry point to renderer/ directory (shakacode#3165) docs: address RSC pitfalls review follow-ups (shakacode#3155) (shakacode#3156) docs: remove fabricated DevConsole reference, link verified RSC tools (shakacode#2527) (shakacode#3163) # Conflicts: # docs/oss/building-features/node-renderer/js-configuration.md
⚡ Risk Assessment —
|
| Files | Summary |
|---|---|
Migration Documentationdocs/oss/migrating/example-migrations.mddocs/oss/migrating/migrating-from-react-rails.mddocs/oss/migrating/migrating-from-vite-rails.mddocs/sidebars.ts |
Adds new example migrations guide with practical patterns and updates existing migration docs with cross-references and improved guidance for users migrating from react-rails and vite-rails. |
Documentation Indexdocs/README.mddocs/oss/misc/doctrine.md |
Updates main documentation index and project doctrine references to reflect new migration resources. |
Dig Deeper With Commands
/review <file-path> <function-optional>/chat <file-path> "<question>"/roast <file-path>
Runs only when explicitly triggered.
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
2 participants
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.
Mirror of upstream shakacode#3126 for benchmark. Do not merge.
Summary by MergeMonkey