Skip to content

Commit 62d92e1

Browse files
authored
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
1 parent 6c77213 commit 62d92e1

File tree

72 files changed

+4334
-194
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+4334
-194
lines changed

docs/README.md

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
New to React on Rails? Start here for the fastest path to success:
88

9-
**[15-Minute Quick Start Guide](./quick-start/README.md)**
9+
**[15-Minute Quick Start Guide](./getting-started/quick-start.md)**
1010

11-
Already have Rails + Shakapacker? **[Add to existing app guide](./guides/installation-into-an-existing-rails-app.md)**
11+
Already have Rails + Shakapacker? **[Add to existing app guide](./getting-started/installation-into-an-existing-rails-app.md)**
1212

1313
## 📚 Learning Paths
1414

@@ -18,72 +18,72 @@ Choose your journey based on your experience level:
1818

1919
Perfect if you're new to React on Rails
2020

21-
1. **[Quick Start](./quick-start/README.md)** - Get your first component running
21+
1. **[Quick Start](./getting-started/quick-start.md)** - Get your first component running
2222
2. **[Core Concepts](./getting-started.md)** - Understand the basics
23-
3. **[Tutorial](./guides/tutorial.md)** - Build something useful
23+
3. **[Tutorial](./getting-started/tutorial.md)** - Build something useful
2424

2525
### **Experienced Developer Path**
2626

2727
Jump to what you need
2828

29-
- **[Installation Guide](./guides/installation-into-an-existing-rails-app.md)** - Detailed setup
30-
- **[API Reference](./api/README.md)** - Quick lookup
29+
- **[Installation Guide](./getting-started/installation-into-an-existing-rails-app.md)** - Detailed setup
30+
- **[API Reference](./api-reference/README.md)** - Quick lookup
3131
- **[Advanced Features](./guides/advanced/README.md)** - SSR, Redux, Router
3232

3333
### 🏗️ **Migrating from Other Solutions**
3434

35-
- **[From react-rails](./additional-details/migrating-from-react-rails.md)** - Switch from the react-rails gem
36-
- **[Upgrading React on Rails](./guides/upgrading-react-on-rails.md)** - Version upgrade guide
35+
- **[From react-rails](./migrating/migrating-from-react-rails.md)** - Switch from the react-rails gem
36+
- **[Upgrading React on Rails](./upgrading/upgrading-react-on-rails.md)** - Version upgrade guide
3737

3838
## 🎯 Popular Use Cases
3939

4040
Find guidance for your specific scenario:
4141

42-
| I want to... | Go here |
43-
| ----------------------------------- | -------------------------------------------------------------------------- |
44-
| **Add React to existing Rails app** | [Installation Guide](./guides/installation-into-an-existing-rails-app.md) |
45-
| **Enable server-side rendering** | [SSR Guide](./guides/react-server-rendering.md) |
46-
| **Set up hot reloading** | [HMR Setup](./guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md) |
47-
| **Use Redux with Rails** | [Redux Integration](./javascript/react-and-redux.md) |
48-
| **Deploy to production** | [Deployment Guide](./guides/deployment.md) |
49-
| **Troubleshoot issues** | [Troubleshooting](./troubleshooting/README.md) |
42+
| I want to... | Go here |
43+
| ----------------------------------- | ------------------------------------------------------------------------------------- |
44+
| **Add React to existing Rails app** | [Installation Guide](./getting-started/installation-into-an-existing-rails-app.md) |
45+
| **Enable server-side rendering** | [SSR Guide](./core-concepts/react-server-rendering.md) |
46+
| **Set up hot reloading** | [HMR Setup](./building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md) |
47+
| **Use Redux with Rails** | [Redux Integration](./building-features/react-and-redux.md) |
48+
| **Deploy to production** | [Deployment Guide](./deployment/deployment.md) |
49+
| **Troubleshoot issues** | [Troubleshooting](./deployment/troubleshooting.md) |
5050

5151
## 📖 Complete Documentation
5252

5353
### Core Guides
5454

5555
- **[Getting Started](./getting-started.md)** - Installation and basic setup
56-
- **[Tutorial](./guides/tutorial.md)** - Complete walkthrough with examples
57-
- **[Configuration](./guides/configuration.md)** - All configuration options
58-
- **[View Helpers](./api/view-helpers-api.md)** - Using `react_component` method
56+
- **[Tutorial](./getting-started/tutorial.md)** - Complete walkthrough with examples
57+
- **[Configuration](./api-reference/configuration.md)** - All configuration options
58+
- **[View Helpers](./api-reference/view-helpers-api.md)** - Using `react_component` method
5959

6060
### Features
6161

62-
- **[Server-Side Rendering](./guides/react-server-rendering.md)** - SSR setup and optimization
63-
- **[Auto-Bundling](./guides/auto-bundling-file-system-based-automated-bundle-generation.md)** - Automatic bundle generation
64-
- **[Redux Integration](./javascript/react-and-redux.md)** - State management with Redux
65-
- **[React Router](./javascript/react-router.md)** - Client-side routing
66-
- **[Internationalization](./guides/i18n.md)** - I18n support
62+
- **[Server-Side Rendering](./core-concepts/react-server-rendering.md)** - SSR setup and optimization
63+
- **[Auto-Bundling](./core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md)** - Automatic bundle generation
64+
- **[Redux Integration](./building-features/react-and-redux.md)** - State management with Redux
65+
- **[React Router](./building-features/react-router.md)** - Client-side routing
66+
- **[Internationalization](./building-features/i18n.md)** - I18n support
6767

6868
### Development
6969

70-
- **[Hot Module Replacement](./guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md)** - Fast development workflow
71-
- **[Testing](./guides/rspec-configuration.md)** - Testing React components
72-
- **[Debugging](./javascript/troubleshooting-build-errors.md)** - Common debugging techniques
70+
- **[Hot Module Replacement](./building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md)** - Fast development workflow
71+
- **[Testing](./building-features/rspec-configuration.md)** - Testing React components
72+
- **[Debugging](./deployment/troubleshooting-build-errors.md)** - Common debugging techniques
7373

7474
### Deployment & Performance
7575

76-
- **[Deployment](./guides/deployment.md)** - Production deployment guide
77-
- **[Performance](./guides/webpack-configuration.md)** - Optimization techniques
78-
- **[Bundle Optimization](./guides/webpack-configuration.md)** - Reduce bundle size
76+
- **[Deployment](./deployment/deployment.md)** - Production deployment guide
77+
- **[Performance](./core-concepts/webpack-configuration.md)** - Optimization techniques
78+
- **[Bundle Optimization](./core-concepts/webpack-configuration.md)** - Reduce bundle size
7979

8080
## 🆘 Need Help?
8181

8282
### Quick Solutions
8383

84-
- **[Troubleshooting Guide](./troubleshooting/README.md)** - Common issues and solutions
85-
- **[FAQ](./troubleshooting/README.md)** - Frequently asked questions
86-
- **[Error Messages](./javascript/troubleshooting-build-errors.md)** - Decode error messages
84+
- **[Troubleshooting Guide](./deployment/troubleshooting.md)** - Common issues and solutions
85+
- **[FAQ](./deployment/troubleshooting.md)** - Frequently asked questions
86+
- **[Error Messages](./deployment/troubleshooting-build-errors.md)** - Decode error messages
8787

8888
### Community Support
8989

@@ -108,62 +108,62 @@ Find guidance for your specific scenario:
108108

109109
### API Reference
110110

111-
- [View Helpers API](./api/view-helpers-api.md)
112-
- [Redux Store API](./api/redux-store-api.md)
113-
- [JavaScript API](./api/javascript-api.md)
111+
- [View Helpers API](./api-reference/view-helpers-api.md)
112+
- [Redux Store API](./api-reference/redux-store-api.md)
113+
- [JavaScript API](./api-reference/javascript-api.md)
114114

115115
### Guides
116116

117117
#### Getting Started
118118

119119
- [Installation](./getting-started.md)
120-
- [Tutorial](./guides/tutorial.md)
121-
- [Basic Configuration](./guides/configuration.md)
120+
- [Tutorial](./getting-started/tutorial.md)
121+
- [Basic Configuration](./api-reference/configuration.md)
122122

123123
#### Core Features
124124

125-
- [Server-Side Rendering](./guides/react-server-rendering.md)
126-
- [Component Registration](./guides/render-functions-and-railscontext.md)
127-
- [Props and RailsContext](./guides/render-functions-and-railscontext.md)
125+
- [Server-Side Rendering](./core-concepts/react-server-rendering.md)
126+
- [Component Registration](./core-concepts/render-functions-and-railscontext.md)
127+
- [Props and RailsContext](./core-concepts/render-functions-and-railscontext.md)
128128

129129
#### State Management
130130

131-
- [Redux Integration](./javascript/react-and-redux.md)
132-
- [Context API](./guides/render-functions-and-railscontext.md)
131+
- [Redux Integration](./building-features/react-and-redux.md)
132+
- [Context API](./core-concepts/render-functions-and-railscontext.md)
133133

134134
#### Routing
135135

136-
- [React Router Setup](./javascript/react-router.md)
137-
- [Server-Side Routing](./guides/react-server-rendering.md)
136+
- [React Router Setup](./building-features/react-router.md)
137+
- [Server-Side Routing](./core-concepts/react-server-rendering.md)
138138

139139
#### Advanced Topics
140140

141-
- [Webpack Configuration](./guides/webpack-configuration.md)
142-
- [Code Splitting](./javascript/code-splitting.md)
143-
- [Performance Optimization](./guides/webpack-configuration.md)
141+
- [Webpack Configuration](./core-concepts/webpack-configuration.md)
142+
- [Code Splitting](./building-features/code-splitting.md)
143+
- [Performance Optimization](./core-concepts/webpack-configuration.md)
144144

145145
#### Development
146146

147-
- [Hot Module Replacement](./guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md)
148-
- [Testing Components](./guides/rspec-configuration.md)
149-
- [Debugging](./javascript/troubleshooting-build-errors.md)
147+
- [Hot Module Replacement](./building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md)
148+
- [Testing Components](./building-features/rspec-configuration.md)
149+
- [Debugging](./deployment/troubleshooting-build-errors.md)
150150

151151
#### Deployment
152152

153-
- [Production Setup](./guides/deployment.md)
154-
- [Heroku Deployment](./guides/deployment.md)
155-
- [Docker Setup](./guides/deployment.md)
153+
- [Production Setup](./deployment/deployment.md)
154+
- [Heroku Deployment](./deployment/deployment.md)
155+
- [Docker Setup](./deployment/deployment.md)
156156

157157
### Migration Guides
158158

159-
- [Upgrading React on Rails](./guides/upgrading-react-on-rails.md)
160-
- [From react-rails gem](./additional-details/migrating-from-react-rails.md)
159+
- [Upgrading React on Rails](./upgrading/upgrading-react-on-rails.md)
160+
- [From react-rails gem](./migrating/migrating-from-react-rails.md)
161161

162162
### Troubleshooting
163163

164-
- [Common Issues](./troubleshooting/README.md)
165-
- [Error Messages](./javascript/troubleshooting-build-errors.md)
166-
- [Performance Issues](./javascript/troubleshooting-build-errors.md)
164+
- [Common Issues](./deployment/troubleshooting.md)
165+
- [Error Messages](./deployment/troubleshooting-build-errors.md)
166+
- [Performance Issues](./deployment/troubleshooting-build-errors.md)
167167

168168
### Contributing
169169

docs/additional-details/updating-dependencies.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/additional-details/manual-installation-overview.md renamed to docs/advanced-topics/manual-installation-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The only requirements within this directory for basic React on Rails integration
1313
1. Your Webpack configuration files:
1414
1. Create outputs in a directory like `/public/webpack`, which is customizable in your `config/initializers/react_on_rails.rb`.
1515
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).
1717
1. Set your registration file as an "entry" point in your Webpack configs.
1818
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`.
1919

File renamed without changes.

docs/api-reference/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# API Reference
2+
3+
Complete API documentation for React on Rails.
4+
5+
- [View Helpers API](../api-reference/view-helpers-api.md)
6+
- [Redux Store API](../api-reference/redux-store-api.md)
7+
- [JavaScript API](../api-reference/javascript-api.md)
File renamed without changes.

docs/additional-details/generator-details.md renamed to docs/api-reference/generator-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Then you may run
3737
`rails s`
3838
```
3939

40-
Another good option is to create a simple test app per the [Tutorial](../guides/tutorial.md).
40+
Another good option is to create a simple test app per the [Tutorial](../getting-started/tutorial.md).
4141

4242
# Understanding the Organization of the Generated Client Code
4343

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)