You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Reorganize documentation into 10 user-journey-based categories (#1845)
Reorganize documentation into 10 user-journey-based categories (#1845)
Why
- Previous 11-category structure had confusing catch-all categories
(Guides, Additional details, Misc, Javascript) with no clear
beginner-to-advanced progression, making information hard to find.
- Users needed a structure organized by WHEN and WHY they need info
rather than by technology type.
Summary
- Reorganized 56 documentation files from 11 scattered categories
into 10 intent-based categories following the user journey from
getting started through building features to deployment.
- Preserved all git history using git mv, kept original filenames,
and updated 133+ internal documentation links to reflect new paths.
- Fixed all broken external GitHub links (shakapacker TypeScript
migration, outdated tutorial references).
Key improvements
- New categories: Getting Started, Core Concepts, Building Features,
API Reference, Deployment, Upgrading, Migrating, Pro, Advanced
Topics, Misc, Outdated
- Split Upgrading (version upgrades) from Migrating (switching from
other tools) for clearer navigation
- Merged duplicate dependency documentation into single source
- Fixed 133+ broken internal links after reorganization
- Updated external links to shakapacker TypeScript files (.js to .ts)
- Removed references to non-existent react-webpack-rails-tutorial
RouterApp files
Copy file name to clipboardExpand all lines: docs/advanced-topics/manual-installation-overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The only requirements within this directory for basic React on Rails integration
13
13
1. Your Webpack configuration files:
14
14
1. Create outputs in a directory like `/public/webpack`, which is customizable in your `config/initializers/react_on_rails.rb`.
15
15
1. Provide server rendering if you wish to use that feature.
16
-
1. Your JavaScript code "registers" any components and stores per the ReactOnRails APIs of ReactOnRails.register(components) and ReactOnRails.registerStore(stores). See [our JavaScript API docs](../api/javascript-api.md) and the [React on Rails source](https://github.com/shakacode/react_on_rails/tree/master/packages/react-on-rails/src/ReactOnRails.client.ts).
16
+
1. Your JavaScript code "registers" any components and stores per the ReactOnRails APIs of ReactOnRails.register(components) and ReactOnRails.registerStore(stores). See [our JavaScript API docs](../api-reference/javascript-api.md) and the [React on Rails source](https://github.com/shakacode/react_on_rails/tree/master/packages/react-on-rails/src/ReactOnRails.client.ts).
17
17
1. Set your registration file as an "entry" point in your Webpack configs.
18
18
1. Configure scripts in `client/package.json` as shown in the example apps. These are used for building your Webpack assets. Also do this for your top-level `package.json`.
0 commit comments