Skip to content

Commit d6776e5

Browse files
ihabadhamihabadham
committed
Simplify docs/README.md and enhance introduction.md
- Simplify docs/README.md for GitHub users: - Direct users to website first - Keep valuable learning paths from PR #1813 - Keep popular use cases table - Add documentation categories overview - Remove duplicate content (now in introduction.md) - Reduced from 173 lines to 65 lines - Enhance introduction.md: - Add missing react_on_rails_demo_ssr_hmr example repo - Now has all 3 example repos (spec/dummy, demo SSR/HMR, live reactrails.com) Purpose: docs/README.md serves GitHub users browsing repo structure, while introduction.md serves as website homepage. Different audiences, minimal duplication.
1 parent db835ed commit d6776e5

File tree

2 files changed

+28
-135
lines changed

2 files changed

+28
-135
lines changed

‎docs/README.md‎

Lines changed: 27 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
# React on Rails Documentation
22

3-
> **Integrate React components seamlessly into your Rails application with server-side rendering, hot reloading, and more.**
3+
> For the best experience, visit our **[documentation website](https://www.shakacode.com/react-on-rails/docs/)**.
44
5-
## 🚀 Quick Start
6-
7-
New to React on Rails? Start here for the fastest path to success:
8-
9-
**→ [15-Minute Quick Start Guide](./getting-started/quick-start.md)**
10-
11-
Already have Rails + Shakapacker? **→ [Add to existing app guide](./getting-started/installation-into-an-existing-rails-app.md)**
5+
Browsing on GitHub? This guide will help you navigate the documentation.
126

137
## 📚 Learning Paths
148

@@ -18,17 +12,17 @@ Choose your journey based on your experience level:
1812

1913
Perfect if you're new to React on Rails
2014

21-
1. **[Quick Start](./getting-started/quick-start.md)** - Get your first component running
22-
2. **[Core Concepts](./getting-started.md)** - Understand the basics
23-
3. **[Tutorial](./getting-started/tutorial.md)** - Build something useful
15+
1. **[Introduction](./introduction.md)** - What is React on Rails and why use it?
16+
2. **[Quick Start](./getting-started/quick-start.md)** - Get your first component running in 15 minutes
17+
3. **[Tutorial](./getting-started/tutorial.md)** - Build a complete app with Redux and routing
2418

2519
### ⚡ **Experienced Developer Path**
2620

27-
Jump to what you need
21+
Jump straight to what you need
2822

29-
- **[Installation Guide](./getting-started/installation-into-an-existing-rails-app.md)** - Detailed setup
30-
- **[API Reference](./api-reference/README.md)** - Quick lookup
31-
- **[Advanced Features](./guides/advanced/README.md)** - SSR, Redux, Router
23+
- **[Installation Guide](./getting-started/installation-into-an-existing-rails-app.md)** - Add to existing Rails app
24+
- **[API Reference](./api-reference/README.md)** - View helpers, configuration, JavaScript API
25+
- **[Core Concepts](./core-concepts/how-react-on-rails-works.md)** - Architecture and SSR
3226

3327
### 🏗️ **Migrating from Other Solutions**
3428

@@ -39,134 +33,32 @@ Jump to what you need
3933

4034
Find guidance for your specific scenario:
4135

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) |
36+
| I want to... | Go here |
37+
| ----------------------------------- | -------------------------------------------------------------------------------------- |
38+
| **Add React to existing Rails app** | [Installation Guide](./getting-started/installation-into-an-existing-rails-app.md) |
39+
| **Enable server-side rendering** | [SSR Guide](./core-concepts/react-server-rendering.md) |
4640
| **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) |
50-
51-
## 📖 Complete Documentation
52-
53-
### Core Guides
54-
55-
- **[Getting Started](./getting-started.md)** - Installation and basic setup
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
59-
60-
### Features
61-
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
67-
68-
### Development
69-
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
41+
| **Use Redux with Rails** | [Redux Integration](./building-features/react-and-redux.md) |
42+
| **Deploy to production** | [Deployment Guide](./deployment/deployment.md) |
43+
| **Troubleshoot issues** | [Troubleshooting](./deployment/troubleshooting.md) |
7344

74-
### Deployment & Performance
45+
## 📖 Documentation Categories
7546

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
47+
- **[Getting Started](./getting-started/)** - Installation, quick start, tutorial
48+
- **[Core Concepts](./core-concepts/)** - How React on Rails works, SSR, auto-bundling
49+
- **[Building Features](./building-features/)** - Redux, routing, i18n, testing
50+
- **[API Reference](./api-reference/)** - View helpers, configuration, JavaScript API
51+
- **[Deployment](./deployment/)** - Production deployment and troubleshooting
52+
- **[Upgrading](./upgrading/)** - Version upgrade guides
53+
- **[Migrating](./migrating/)** - From other frameworks
54+
- **[Pro](./pro/)** - React on Rails Pro features
7955

8056
## 🆘 Need Help?
8157

82-
### Quick Solutions
83-
8458
- **[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
87-
88-
### Community Support
89-
90-
- **[React + Rails Slack](https://reactrails.slack.com)** - Real-time community help
9159
- **[GitHub Discussions](https://github.com/shakacode/react_on_rails/discussions)** - Ask questions
92-
- **[GitHub Issues](https://github.com/shakacode/react_on_rails/issues)** - Report bugs
93-
94-
### Professional Support
95-
96-
- **[ShakaCode Support](mailto:react_on_rails@shakacode.com)** - Professional React on Rails help
97-
- **[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)** - Advanced features and support
98-
99-
## 🔗 External Resources
100-
101-
- **[Shakapacker Documentation](https://github.com/shakacode/shakapacker)** - Webpack integration for Rails
102-
- **[React Documentation](https://react.dev)** - Official React docs
103-
- **[Rails Guides](https://guides.rubyonrails.org)** - Ruby on Rails documentation
60+
- **[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)** - Advanced features and professional support
10461

10562
---
10663

107-
## 📚 Table of Contents
108-
109-
### API Reference
110-
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)
114-
115-
### Guides
116-
117-
#### Getting Started
118-
119-
- [Installation](./getting-started.md)
120-
- [Tutorial](./getting-started/tutorial.md)
121-
- [Basic Configuration](./api-reference/configuration.md)
122-
123-
#### Core Features
124-
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)
128-
129-
#### State Management
130-
131-
- [Redux Integration](./building-features/react-and-redux.md)
132-
- [Context API](./core-concepts/render-functions-and-railscontext.md)
133-
134-
#### Routing
135-
136-
- [React Router Setup](./building-features/react-router.md)
137-
- [Server-Side Routing](./core-concepts/react-server-rendering.md)
138-
139-
#### Advanced Topics
140-
141-
- [Webpack Configuration](./core-concepts/webpack-configuration.md)
142-
- [Code Splitting](./building-features/code-splitting.md)
143-
- [Performance Optimization](./core-concepts/webpack-configuration.md)
144-
145-
#### Development
146-
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)
150-
151-
#### Deployment
152-
153-
- [Production Setup](./deployment/deployment.md)
154-
- [Heroku Deployment](./deployment/deployment.md)
155-
- [Docker Setup](./deployment/deployment.md)
156-
157-
### Migration Guides
158-
159-
- [Upgrading React on Rails](./upgrading/upgrading-react-on-rails.md)
160-
- [From react-rails gem](./migrating/migrating-from-react-rails.md)
161-
162-
### Troubleshooting
163-
164-
- [Common Issues](./deployment/troubleshooting.md)
165-
- [Error Messages](./deployment/troubleshooting-build-errors.md)
166-
- [Performance Issues](./deployment/troubleshooting-build-errors.md)
167-
168-
### Contributing
169-
170-
- [Contributing Guide](../CONTRIBUTING.md)
171-
- [Development Setup](../CONTRIBUTING.md)
172-
- [Pull Request Guidelines](../CONTRIBUTING.md)
64+
**💡 Tip:** For the best reading experience with full navigation and search, visit the [documentation website](https://www.shakacode.com/react-on-rails/docs/).

‎docs/introduction.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ Step-by-step walkthrough building a full app with Redux, routing, and deployment
6565
### 👀 Learn by Example?
6666

6767
- **[Spec/Dummy App](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy)** - Simple example in this repo
68+
- **[Tutorial Demo App](https://github.com/shakacode/react_on_rails_demo_ssr_hmr)** - Example with SSR, HMR, and TypeScript
6869
- **[Live Demo with Source](https://github.com/shakacode/react-webpack-rails-tutorial)** - Full production app at [reactrails.com](https://reactrails.com)
6970

7071
## Popular Use Cases

0 commit comments

Comments
 (0)