-
-
Notifications
You must be signed in to change notification settings - Fork 638
docs: Entry Point Consolidation and Tutorial Improvements #1860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
11dbcd0
Remove orphaned docs/guides/advanced/README.md
ihabadham 946b379
Create introduction.md and remove redundant overview
ihabadham e66d685
Simplify docs/README.md and enhance introduction.md
ihabadham 2ffdd79
Update ia-redesign-live.md with Phase 3 progress
ihabadham 03b7a5c
Delete docs/home.md - replaced by introduction.md
ihabadham ff9448f
Transform getting-started.md into understanding-react-on-rails.md
ihabadham 37aa919
Rename understanding-react-on-rails.md to using-react-on-rails.md
ihabadham b4ab825
Improve tutorial: extract Heroku deployment, fix versions, reorganize…
ihabadham 1ac083c
Delete outdated manual-installation-overview.md
ihabadham 56c8253
Update IA redesign plan to reflect Phase 3 completion
ihabadham 63f3269
linting
ihabadham 783932e
Fix MDX parsing error in quick-start.md
ihabadham 1d272e0
Fix documentation H1 headings for improved search indexing
ihabadham c284802
Fix multiple H1 headings in documentation for improved search indexing
ihabadham 8968b76
Restructure turbolinks.md to clarify Turbo vs legacy Turbolinks
ihabadham 7852926
Modernize generator and project structure documentation
ihabadham 6fc4e3f
Update React Router documentation and spec/dummy to v6
ihabadham 5f81100
Modernize process manager documentation
ihabadham e15835a
Move outdated code-splitting.md to outdated/ and update references
ihabadham 0c423b0
Fix broken links to outdated/webpack.md
ihabadham 90f81ec
Remove outdated documentation folder
ihabadham 1f4476d
Fix failing RSpec test after process manager docs update
ihabadham 58601dd
Fix broken markdown links to turbolinks.md
ihabadham 0465ff4
Enable React Router v7 future flags to silence warnings in tests
ihabadham 4de99d5
Fix documentation issues identified in PR review
ihabadham 19e112c
typo
ihabadham 9662d9b
Remove redundant api-reference/README.md
ihabadham e6f9b1e
fix dead link
ihabadham 7a87399
another dead link
ihabadham c3c7640
Update Node.js requirement from 18+/16 to 20+ across documentation
ihabadham f0d6fe6
Fix broken React Router v6 migration guide link
ihabadham 28b8c8f
Fix inconsistent link text in how-to-conditionally-server-render doc
github-actions[bot] 1f05e1a
Document Turbo integration and immediate_hydration feature (resolve T…
ihabadham d719da4
Remove confusing "(Free)" label from Turbo Basic Setup heading
ihabadham f76707c
Fix multiple H1 headings in client-vs-server-rendering.md
ihabadham File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,8 @@ | ||
| # React on Rails Documentation | ||
|
|
||
| > **Integrate React components seamlessly into your Rails application with server-side rendering, hot reloading, and more.** | ||
| > For the best experience, visit our **[documentation website](https://www.shakacode.com/react-on-rails/docs/)**. | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| New to React on Rails? Start here for the fastest path to success: | ||
|
|
||
| **→ [15-Minute Quick Start Guide](./getting-started/quick-start.md)** | ||
|
|
||
| Already have Rails + Shakapacker? **→ [Add to existing app guide](./getting-started/installation-into-an-existing-rails-app.md)** | ||
| Browsing on GitHub? This guide will help you navigate the documentation. | ||
|
|
||
| ## 📚 Learning Paths | ||
|
|
||
|
|
@@ -18,17 +12,17 @@ Choose your journey based on your experience level: | |
|
|
||
| Perfect if you're new to React on Rails | ||
|
|
||
| 1. **[Quick Start](./getting-started/quick-start.md)** - Get your first component running | ||
| 2. **[Core Concepts](./getting-started.md)** - Understand the basics | ||
| 3. **[Tutorial](./getting-started/tutorial.md)** - Build something useful | ||
| 1. **[Introduction](./introduction.md)** - What is React on Rails and why use it? | ||
| 2. **[Quick Start](./getting-started/quick-start.md)** - Get your first component running in 15 minutes | ||
| 3. **[Tutorial](./getting-started/tutorial.md)** - Build a complete app with Redux and routing | ||
|
|
||
| ### ⚡ **Experienced Developer Path** | ||
|
|
||
| Jump to what you need | ||
| Jump straight to what you need | ||
|
|
||
| - **[Installation Guide](./getting-started/installation-into-an-existing-rails-app.md)** - Detailed setup | ||
| - **[API Reference](./api-reference/README.md)** - Quick lookup | ||
| - **[Advanced Features](./guides/advanced/README.md)** - SSR, Redux, Router | ||
| - **[Installation Guide](./getting-started/installation-into-an-existing-rails-app.md)** - Add to existing Rails app | ||
| - **[API Reference](./api-reference/view-helpers-api.md)** - View helpers, configuration, JavaScript API | ||
| - **[Core Concepts](./core-concepts/how-react-on-rails-works.md)** - Architecture and SSR | ||
|
|
||
| ### 🏗️ **Migrating from Other Solutions** | ||
|
|
||
|
|
@@ -48,125 +42,23 @@ Find guidance for your specific scenario: | |
| | **Deploy to production** | [Deployment Guide](./deployment/deployment.md) | | ||
| | **Troubleshoot issues** | [Troubleshooting](./deployment/troubleshooting.md) | | ||
|
|
||
| ## 📖 Complete Documentation | ||
|
|
||
| ### Core Guides | ||
|
|
||
| - **[Getting Started](./getting-started.md)** - Installation and basic setup | ||
| - **[Tutorial](./getting-started/tutorial.md)** - Complete walkthrough with examples | ||
| - **[Configuration](./api-reference/configuration.md)** - All configuration options | ||
| - **[View Helpers](./api-reference/view-helpers-api.md)** - Using `react_component` method | ||
|
|
||
| ### Features | ||
|
|
||
| - **[Server-Side Rendering](./core-concepts/react-server-rendering.md)** - SSR setup and optimization | ||
| - **[Auto-Bundling](./core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md)** - Automatic bundle generation | ||
| - **[Redux Integration](./building-features/react-and-redux.md)** - State management with Redux | ||
| - **[React Router](./building-features/react-router.md)** - Client-side routing | ||
| - **[Internationalization](./building-features/i18n.md)** - I18n support | ||
|
|
||
| ### Development | ||
|
|
||
| - **[Hot Module Replacement](./building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md)** - Fast development workflow | ||
| - **[Testing](./building-features/rspec-configuration.md)** - Testing React components | ||
| - **[Debugging](./deployment/troubleshooting-build-errors.md)** - Common debugging techniques | ||
|
|
||
| ### Deployment & Performance | ||
| ## 📖 Documentation Categories | ||
|
|
||
| - **[Deployment](./deployment/deployment.md)** - Production deployment guide | ||
| - **[Performance](./core-concepts/webpack-configuration.md)** - Optimization techniques | ||
| - **[Bundle Optimization](./core-concepts/webpack-configuration.md)** - Reduce bundle size | ||
| - **[Getting Started](./getting-started/)** - Installation, quick start, tutorial | ||
| - **[Core Concepts](./core-concepts/)** - How React on Rails works, SSR, auto-bundling | ||
| - **[Building Features](./building-features/)** - Redux, routing, i18n, testing | ||
| - **[API Reference](./api-reference/)** - View helpers, configuration, JavaScript API | ||
| - **[Deployment](./deployment/)** - Production deployment and troubleshooting | ||
| - **[Upgrading](./upgrading/)** - Version upgrade guides | ||
| - **[Migrating](./migrating/)** - From other frameworks | ||
| - **[Pro](./pro/)** - React on Rails Pro features | ||
|
|
||
| ## 🆘 Need Help? | ||
|
|
||
| ### Quick Solutions | ||
|
|
||
| - **[Troubleshooting Guide](./deployment/troubleshooting.md)** - Common issues and solutions | ||
| - **[FAQ](./deployment/troubleshooting.md)** - Frequently asked questions | ||
| - **[Error Messages](./deployment/troubleshooting-build-errors.md)** - Decode error messages | ||
|
|
||
| ### Community Support | ||
|
|
||
| - **[React + Rails Slack](https://reactrails.slack.com)** - Real-time community help | ||
| - **[GitHub Discussions](https://github.com/shakacode/react_on_rails/discussions)** - Ask questions | ||
| - **[GitHub Issues](https://github.com/shakacode/react_on_rails/issues)** - Report bugs | ||
|
|
||
| ### Professional Support | ||
|
|
||
| - **[ShakaCode Support](mailto:[email protected])** - Professional React on Rails help | ||
| - **[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)** - Advanced features and support | ||
|
|
||
| ## 🔗 External Resources | ||
|
|
||
| - **[Shakapacker Documentation](https://github.com/shakacode/shakapacker)** - Webpack integration for Rails | ||
| - **[React Documentation](https://react.dev)** - Official React docs | ||
| - **[Rails Guides](https://guides.rubyonrails.org)** - Ruby on Rails documentation | ||
| - **[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)** - Advanced features and professional support | ||
|
|
||
| --- | ||
|
|
||
| ## 📚 Table of Contents | ||
|
|
||
| ### API Reference | ||
|
|
||
| - [View Helpers API](./api-reference/view-helpers-api.md) | ||
| - [Redux Store API](./api-reference/redux-store-api.md) | ||
| - [JavaScript API](./api-reference/javascript-api.md) | ||
|
|
||
| ### Guides | ||
|
|
||
| #### Getting Started | ||
|
|
||
| - [Installation](./getting-started.md) | ||
| - [Tutorial](./getting-started/tutorial.md) | ||
| - [Basic Configuration](./api-reference/configuration.md) | ||
|
|
||
| #### Core Features | ||
|
|
||
| - [Server-Side Rendering](./core-concepts/react-server-rendering.md) | ||
| - [Component Registration](./core-concepts/render-functions-and-railscontext.md) | ||
| - [Props and RailsContext](./core-concepts/render-functions-and-railscontext.md) | ||
|
|
||
| #### State Management | ||
|
|
||
| - [Redux Integration](./building-features/react-and-redux.md) | ||
| - [Context API](./core-concepts/render-functions-and-railscontext.md) | ||
|
|
||
| #### Routing | ||
|
|
||
| - [React Router Setup](./building-features/react-router.md) | ||
| - [Server-Side Routing](./core-concepts/react-server-rendering.md) | ||
|
|
||
| #### Advanced Topics | ||
|
|
||
| - [Webpack Configuration](./core-concepts/webpack-configuration.md) | ||
| - [Code Splitting](./building-features/code-splitting.md) | ||
| - [Performance Optimization](./core-concepts/webpack-configuration.md) | ||
|
|
||
| #### Development | ||
|
|
||
| - [Hot Module Replacement](./building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md) | ||
| - [Testing Components](./building-features/rspec-configuration.md) | ||
| - [Debugging](./deployment/troubleshooting-build-errors.md) | ||
|
|
||
| #### Deployment | ||
|
|
||
| - [Production Setup](./deployment/deployment.md) | ||
| - [Heroku Deployment](./deployment/deployment.md) | ||
| - [Docker Setup](./deployment/deployment.md) | ||
|
|
||
| ### Migration Guides | ||
|
|
||
| - [Upgrading React on Rails](./upgrading/upgrading-react-on-rails.md) | ||
| - [From react-rails gem](./migrating/migrating-from-react-rails.md) | ||
|
|
||
| ### Troubleshooting | ||
|
|
||
| - [Common Issues](./deployment/troubleshooting.md) | ||
| - [Error Messages](./deployment/troubleshooting-build-errors.md) | ||
| - [Performance Issues](./deployment/troubleshooting-build-errors.md) | ||
|
|
||
| ### Contributing | ||
|
|
||
| - [Contributing Guide](../CONTRIBUTING.md) | ||
| - [Development Setup](../CONTRIBUTING.md) | ||
| - [Pull Request Guidelines](../CONTRIBUTING.md) | ||
| **💡 Tip:** For the best reading experience with full navigation and search, visit the [documentation website](https://www.shakacode.com/react-on-rails/docs/). | ||
This file was deleted.
Oops, something went wrong.
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
This file was deleted.
Oops, something went wrong.
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm pretty sure that @justin808 will want this left on the Readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't delete it entirely, it was moved to introduction.md to keep the docs/README focused on technical content and the TOC, while referring readers to the docs website for more in-depth information. do we need to put it here as well regardless?