Skip to content

Commit 66b14af

Browse files
justin808claude
andcommitted
Fix broken links and reconcile version requirements
- Update 20+ broken links in docs/README.md to point to existing files - Fix 5 broken links in docs/quick-start/README.md - Fix image path in docs/getting-started.md (../images -> ./images) - Update Storybook URL to current domain (getstorybook.io -> storybook.js.org) - Reconcile version requirements across docs to match gemspec: - Shakapacker 6+ (7+ recommended) instead of "7+ required" - Ruby 3.0+ (required) instead of "Ruby 2.7+ supported" - Rails 5.2+ supported for consistency 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 29f37b6 commit 66b14af

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

docs/README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Perfect if you're new to React on Rails
2626

2727
Jump to what you need
2828

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

@@ -68,22 +68,22 @@ Find guidance for your specific scenario:
6868
### Development
6969

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

7474
### Deployment & Performance
7575

7676
- **[Deployment](./guides/deployment.md)** - Production deployment guide
77-
- **[Performance](./guides/performance/README.md)** - Optimization techniques
78-
- **[Bundle Optimization](./guides/performance/webpack-bundle-optimization.md)** - Reduce bundle size
77+
- **[Performance](./guides/webpack-configuration.md)** - Optimization techniques
78+
- **[Bundle Optimization](./guides/webpack-configuration.md)** - Reduce bundle size
7979

8080
## 🆘 Need Help?
8181

8282
### Quick Solutions
8383

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

8888
### Community Support
8989

@@ -110,7 +110,7 @@ Find guidance for your specific scenario:
110110

111111
- [View Helpers API](./api/view-helpers-api.md)
112112
- [Redux Store API](./api/redux-store-api.md)
113-
- [Configuration API](./api/configuration-api.md)
113+
- [JavaScript API](./api/javascript-api.md)
114114

115115
### Guides
116116

@@ -122,37 +122,37 @@ Find guidance for your specific scenario:
122122

123123
#### Core Features
124124

125-
- [Server-Side Rendering](./guides/fundamentals/server-rendering.md)
126-
- [Component Registration](./guides/fundamentals/component-registration.md)
125+
- [Server-Side Rendering](./guides/react-server-rendering.md)
126+
- [Component Registration](./guides/render-functions-and-railscontext.md)
127127
- [Props and RailsContext](./guides/render-functions-and-railscontext.md)
128128

129129
#### State Management
130130

131-
- [Redux Integration](./guides/state-management/redux.md)
132-
- [Context API](./guides/state-management/context-api.md)
131+
- [Redux Integration](./javascript/react-and-redux.md)
132+
- [Context API](./guides/render-functions-and-railscontext.md)
133133

134134
#### Routing
135135

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

139139
#### Advanced Topics
140140

141141
- [Webpack Configuration](./guides/webpack-configuration.md)
142142
- [Code Splitting](./javascript/code-splitting.md)
143-
- [Performance Optimization](./guides/performance/README.md)
143+
- [Performance Optimization](./guides/webpack-configuration.md)
144144

145145
#### Development
146146

147-
- [Hot Module Replacement](./guides/development/hot-reloading.md)
148-
- [Testing Components](./guides/development/testing.md)
149-
- [Debugging](./guides/development/debugging.md)
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)
150150

151151
#### Deployment
152152

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

157157
### Migration Guides
158158

@@ -162,11 +162,11 @@ Find guidance for your specific scenario:
162162
### Troubleshooting
163163

164164
- [Common Issues](./troubleshooting/README.md)
165-
- [Error Messages](./troubleshooting/error-messages.md)
166-
- [Performance Issues](./troubleshooting/performance.md)
165+
- [Error Messages](./javascript/troubleshooting-build-errors.md)
166+
- [Performance Issues](./javascript/troubleshooting-build-errors.md)
167167

168168
### Contributing
169169

170170
- [Contributing Guide](../CONTRIBUTING.md)
171-
- [Development Setup](./contributor-info/development.md)
172-
- [Pull Request Guidelines](./contributor-info/pull-requests.md)
171+
- [Development Setup](../CONTRIBUTING.md)
172+
- [Pull Request Guidelines](../CONTRIBUTING.md)

docs/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The best way to understand React on Rails depends on your situation:
2828
## System Requirements
2929

3030
**🚨 React on Rails 16.0+** (this guide covers modern features)
31-
**🚨 Shakapacker 7+** (required for React on Rails 16)
32-
**Rails 7+** (Rails 5+ supported)
33-
**Ruby 3.0+** (Ruby 2.7+ supported)
31+
**🚨 Shakapacker 6+** (7+ recommended for React on Rails 16)
32+
**Rails 7+** (Rails 5.2+ supported)
33+
**Ruby 3.0+** (required)
3434
**Node.js 18+**
3535

3636
> **Don't have Shakapacker?** It's the modern replacement for Webpacker and required for React on Rails.
@@ -165,7 +165,7 @@ The generator set up the following:
165165
2. Rails integration for rendering this component in a Rails view
166166
3. Webpack configuration for building your JavaScript bundle
167167

168-
![Basic Hello World Example](../images/bundle-splitting-hello-world.png)
168+
![Basic Hello World Example](./images/bundle-splitting-hello-world.png)
169169

170170
#### Different Server-Side Rendering Code (and a Server-Specific Bundle)
171171

docs/javascript/angular-js-integration-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Check out the [ngReact](https://github.com/ngReact/ngReact) package. This packag
2020

2121
## StoryBook
2222

23-
We love using [StoryBook](https://getstorybook.io/) to create a simple testing and inspection area of new React components as we migrate them over from AngularJS Components.
23+
We love using [Storybook](https://storybook.js.org/) to create a simple testing and inspection area of new React components as we migrate them over from AngularJS Components.
2424

2525
## Overall Approach?
2626

docs/quick-start/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This guide will have you rendering React components in your Rails app as quickly
99
Before starting, make sure you have:
1010

1111
- **🚨 React on Rails 16.0+** (this guide)
12-
- **🚨 Shakapacker 7+** (required for React on Rails 16)
13-
- **Rails 7+** application (Rails 5+ supported)
14-
- **Ruby 3.0+** (Ruby 2.7+ supported)
12+
- **🚨 Shakapacker 6+** (7+ recommended for React on Rails 16)
13+
- **Rails 7+** application (Rails 5.2+ supported)
14+
- **Ruby 3.0+** (required)
1515
- **Node.js 18+** and **Yarn**
1616
- **Basic familiarity** with React and Rails
1717

@@ -161,18 +161,18 @@ Now that you have React on Rails working, here's what to explore next:
161161

162162
1. **[Basic Configuration](../getting-started.md)** - Understand the setup
163163
2. **[View Helpers API](../api/view-helpers-api.md)** - Learn all the options for `react_component`
164-
3. **[Hot Module Replacement](../guides/development/hot-reloading.md)** - Optimize your dev workflow
164+
3. **[Hot Module Replacement](../guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md)** - Optimize your dev workflow
165165

166166
### Dive Deeper
167167

168168
1. **[Complete Tutorial](../guides/tutorial.md)** - Build a full app with Redux
169-
2. **[Server-Side Rendering](../guides/fundamentals/server-rendering.md)** - Optimize for SEO and performance
170-
3. **[Production Deployment](../guides/deployment/README.md)** - Deploy to production
169+
2. **[Server-Side Rendering](../guides/react-server-rendering.md)** - Optimize for SEO and performance
170+
3. **[Production Deployment](../guides/deployment.md)** - Deploy to production
171171

172172
### Advanced Features
173173

174-
1. **[Redux Integration](../guides/state-management/redux.md)** - Manage application state
175-
2. **[React Router](../guides/routing/react-router.md)** - Client-side routing
174+
1. **[Redux Integration](../javascript/react-and-redux.md)** - Manage application state
175+
2. **[React Router](../javascript/react-router.md)** - Client-side routing
176176
3. **[Code Splitting](../javascript/code-splitting.md)** - Optimize bundle size
177177

178178
## 🆘 Need Help?

0 commit comments

Comments
 (0)