Skip to content

Commit 77c3d67

Browse files
justin808claude
justin808
and
claude
committed
Move OSS docs to docs/oss/ alongside docs/pro/ for clear structure
Create a clean docs/oss/ + docs/pro/ sibling structure so users can easily navigate between open-source and Pro documentation. This builds on #2556 (which consolidated Pro docs into docs/pro/) by giving OSS docs their own subdirectory. Changes: - Move 9 OSS doc subdirectories and introduction.md into docs/oss/ - Move planning docs (MONOREPO_MERGER_PLAN, etc.) to internal/planning/ - Move testimonials to internal/testimonials/ - Rewrite docs/README.md as unified entry point for both OSS and Pro - Update all cross-references in README.md, AGENTS.md, CHANGELOG.md, NEWS.md, Ruby source files, generator templates, spec initializers, and Pro docs that link back to OSS docs Part of #2583 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 77547ed commit 77c3d67

88 files changed

Lines changed: 93 additions & 93 deletions

File tree

Some content is hidden

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

‎AGENTS.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -84,19 +84,19 @@ cd react_on_rails/spec/dummy && bundle exec rspec spec/path/to/spec.rb
8484

8585
## Project Structure
8686

87-
| Directory | Purpose |
88-
| ------------------------------------ | ------------------------------------------------------------------------------------------------------- |
89-
| `react_on_rails/lib/react_on_rails/` | Ruby gem source — helpers, configuration, SSR pool, engine |
90-
| `react_on_rails/lib/generators/` | Rails generators for `react_on_rails:install` |
91-
| `react_on_rails/spec/` | RSpec tests (unit + integration via dummy app) |
92-
| `react_on_rails/spec/dummy/` | Full Rails app for integration testing and E2E |
93-
| `packages/react-on-rails/src/` | TypeScript source — client-side React integration |
94-
| `packages/react-on-rails/tests/` | Jest tests for the npm package |
95-
| `react_on_rails_pro/` | Pro package (separate gem + npm, own lint config) |
96-
| `rakelib/` | Rake task definitions |
97-
| `docs/` | Published to the [ShakaCode website](https://www.shakacode.com/react-on-rails/docs/) — user-facing only |
98-
| `docs/contributor-info/` | Internal contributor docs (excluded from website) |
99-
| `analysis/` | Investigation and analysis documents (kebab-case `.md` files) |
87+
| Directory | Purpose |
88+
| ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
89+
| `react_on_rails/lib/react_on_rails/` | Ruby gem source — helpers, configuration, SSR pool, engine |
90+
| `react_on_rails/lib/generators/` | Rails generators for `react_on_rails:install` |
91+
| `react_on_rails/spec/` | RSpec tests (unit + integration via dummy app) |
92+
| `react_on_rails/spec/dummy/` | Full Rails app for integration testing and E2E |
93+
| `packages/react-on-rails/src/` | TypeScript source — client-side React integration |
94+
| `packages/react-on-rails/tests/` | Jest tests for the npm package |
95+
| `react_on_rails_pro/` | Pro package (separate gem + npm, own lint config) |
96+
| `rakelib/` | Rake task definitions |
97+
| `docs/oss/` | OSS documentation — published to the [ShakaCode website](https://www.shakacode.com/react-on-rails/docs/) |
98+
| `docs/pro/` | Pro documentation — installation, configuration, RSC, node renderer, caching |
99+
| `analysis/` | Investigation and analysis documents (kebab-case `.md` files) |
100100

101101
## Code Style
102102

@@ -180,7 +180,7 @@ For small, focused PRs (roughly 5 files changed or fewer and one clear purpose):
180180
- Skip pre-commit hooks (`--no-verify`)
181181
- Commit secrets, credentials, or `.env` files
182182
- Commit `package-lock.json`, `yarn.lock`, or other non-pnpm lock files
183-
- Add files to the `docs/` root — they must go in a subdirectory (`getting-started/`, `core-concepts/`, `building-features/`, `api-reference/`, `deployment/`, `migrating/`, `upgrading/`, `contributor-info/`, `misc/`)
183+
- Add files to the `docs/` root — OSS docs go in `docs/oss/` subdirectories (`getting-started/`, `core-concepts/`, `building-features/`, `api-reference/`, `deployment/`, `migrating/`, `upgrading/`, `misc/`); Pro docs go in `docs/pro/`
184184
- Force push to `main` or `master`
185185

186186
## Key Concept: File Suffixes vs. RSC Directive

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ _Includes all features from the React on Rails Pro 4.0.0 release series (previou
465465

466466
**React on Rails v16 is a major release that modernizes the library with ESM support, removes legacy Webpacker compatibility, and introduces significant performance improvements. This release builds on the foundation of v14 with enhanced RSC (React Server Components) support and streamlined configuration.**
467467

468-
See [Release Notes](docs/upgrading/release-notes/16.0.0.md) for complete migration guide.
468+
See [Release Notes](docs/oss/upgrading/release-notes/16.0.0.md) for complete migration guide.
469469

470470
#### Major Enhancements
471471

‎NEWS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ _A history of the news. A few bullets at the top will also show on the [README.m
2121
- 2017-04-09: 8.0.0 beta work to include webpacker_lite gem has begun. See [#786](https://github.com/shakacode/react_on_rails/issues/786).
2222
- 2017-04-03: 6.9.3 Released! Props rendered in JSON script tag. Page size is smaller now due to less escaping!
2323
- 2017-03-06: Updated to Webpack v2!
24-
- 2017-03-02: Demo of internationalization (i18n) is live at [reactrails.com](https://reactrails.com/). Docs [here](docs/building-features/i18n.md).
24+
- 2017-03-02: Demo of internationalization (i18n) is live at [reactrails.com](https://reactrails.com/). Docs [here](docs/oss/building-features/i18n.md).
2525
- 2017-02-28: See [discussions here on Webpacker](https://github.com/rails/webpacker/issues/139) regarding how Webpacker will allow React on Rails to avoid using the asset pipeline in the near future.
2626
- 2017-02-28: Upgrade to Webpack v2 or use the `--bail` option in your Webpack script for test and production builds. See the discussion on [PR #730](https://github.com/shakacode/react_on_rails/pull/730).
2727
- 2016-11-03: Spoke at [LA Ruby: "React on Rails: Why, What, and How?"](http://www.meetup.com/laruby/events/234825187/). [Video and pictures in this article](https://blog.shakacode.com/my-react-on-rails-talk-at-the-la-ruby-rails-meetup-november-10-2016-eaaa83aff800#.ej6h4eglp).
@@ -55,7 +55,7 @@ _A history of the news. A few bullets at the top will also show on the [README.m
5555
3. Support for Turbolinks 5!
5656
- There was a fatal error when using the latest version of Redux for server rendering. See [Redux #1335](https://github.com/reduxjs/redux/issues/1335). See [diff 3.1.6...3.1.4](https://github.com/reduxjs/redux/commit/e2e14d26f09ca729ae0555442f50fcfc45bfb423#diff-1fdf421c05c1140f6d71444ea2b27638). Workaround for server rendering: Use Redux 3.1.7 or upgrade to React On Rails v2.3.0. [this commit](https://github.com/shakacode/react_on_rails/commit/59f1e68d3d233775e6abc63bff180ea59ac2d79e) on [PR #244](https://github.com/shakacode/react_on_rails/pull/244/).
5757
- 2.x Highlights:
58-
1. Fixed a **critical** problem with TurboLinks. Be sure to see [turbolinks docs](docs/building-features/turbolinks.md) for more information on how to debug TurboLinks issues.
58+
1. Fixed a **critical** problem with TurboLinks. Be sure to see [turbolinks docs](docs/oss/building-features/turbolinks.md) for more information on how to debug TurboLinks issues.
5959
2. Provides a convenient helper to ensure that JavaScript assets are compiled before running tests.
6060
- React on Rails does not yet have _generator_ support for building new apps that use CSS modules and hot reloading via the Rails server as is demonstrated in the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). _We do support this, but we don't generate the code._ If you did generate a fresh app from react_on_rails and want to move to CSS Modules, then see [PR 175: Babel 6 / CSS Modules / Rails hot reloading](https://github.com/shakacode/react-webpack-rails-tutorial/pull/175). Note, while there are probably fixes after this PR was accepted, this has the majority of the changes. See [the tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/#news) for more information. Ping us if you want to help!
6161
- Be sure to read our article [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724).

‎README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ cd my-app
2626
bin/dev
2727
```
2828

29-
Visit [http://localhost:3000/hello_world](http://localhost:3000/hello_world) - done! TypeScript? Add `--template typescript`. [Full CLI docs →](./docs/getting-started/create-react-on-rails-app.md)
29+
Visit [http://localhost:3000/hello_world](http://localhost:3000/hello_world) - done! TypeScript? Add `--template typescript`. [Full CLI docs →](./docs/oss/getting-started/create-react-on-rails-app.md)
3030

3131
**Or add to an existing Rails app:**
3232

@@ -103,7 +103,7 @@ rake react_on_rails:doctor
103103

104104
The doctor command checks your environment, dependencies, and configuration files to identify potential issues. Use `VERBOSE=true rake react_on_rails:doctor` for detailed output.
105105

106-
For detailed upgrade instructions, see [upgrade guide documentation](docs/upgrading/upgrading-react-on-rails.md).
106+
For detailed upgrade instructions, see [upgrade guide documentation](docs/oss/upgrading/upgrading-react-on-rails.md).
107107

108108
## React on Rails Pro
109109

@@ -138,19 +138,19 @@ To provide a high-performance framework for integrating Ruby on Rails with React
138138

139139
## ✨ Why React on Rails?
140140

141-
| Feature | Benefit |
142-
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
143-
| ⚡ **Rspack Support** | [~20x faster builds](./docs/api-reference/generator-details.md#rspack-support) with Rspack bundler - dramatically reduce build times in development and CI |
144-
| 🎯 **Smart Bundle Loading** | [Automated bundle optimization](./docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md) based on components used - no more manual `javascript_pack_tags` configuration |
145-
| 🌟 **Server-Side Rendering** | Enhanced React Server Components support for better SEO and UX performance |
146-
| 🚀 **Advanced Loading** | `sync`, `async`, and `defer` options for optimal performance based on your needs |
147-
| 🔥 **Hot Module Replacement** | Instant feedback during development with tight [Shakapacker](https://github.com/shakacode/shakapacker) integration |
148-
| 📦 **Easy Props Passing** | Direct Rails → React data flow without separate API calls |
149-
| 🗺️ **Router Integration** | [React Router](https://reactrouter.com/) with SSR support |
150-
| 🏪 **State Management** | [Redux](https://redux.js.org/) integration with server-side rendering |
151-
| 🌍 **Internationalization** | [I18n and localization support](https://www.shakacode.com/react-on-rails/docs/building-features/i18n) for global apps |
152-
| 🎨 **Modern React** | React 18+ with enhanced React Server Components and latest patterns |
153-
| 🦄 **ReScript Support** | [ReScript integration](https://github.com/shakacode/rescript-react-on-rails-example) for type-safe development |
141+
| Feature | Benefit |
142+
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
143+
| ⚡ **Rspack Support** | [~20x faster builds](./docs/oss/api-reference/generator-details.md#rspack-support) with Rspack bundler - dramatically reduce build times in development and CI |
144+
| 🎯 **Smart Bundle Loading** | [Automated bundle optimization](./docs/oss/core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md) based on components used - no more manual `javascript_pack_tags` configuration |
145+
| 🌟 **Server-Side Rendering** | Enhanced React Server Components support for better SEO and UX performance |
146+
| 🚀 **Advanced Loading** | `sync`, `async`, and `defer` options for optimal performance based on your needs |
147+
| 🔥 **Hot Module Replacement** | Instant feedback during development with tight [Shakapacker](https://github.com/shakacode/shakapacker) integration |
148+
| 📦 **Easy Props Passing** | Direct Rails → React data flow without separate API calls |
149+
| 🗺️ **Router Integration** | [React Router](https://reactrouter.com/) with SSR support |
150+
| 🏪 **State Management** | [Redux](https://redux.js.org/) integration with server-side rendering |
151+
| 🌍 **Internationalization** | [I18n and localization support](https://www.shakacode.com/react-on-rails/docs/building-features/i18n) for global apps |
152+
| 🎨 **Modern React** | React 18+ with enhanced React Server Components and latest patterns |
153+
| 🦄 **ReScript Support** | [ReScript integration](https://github.com/shakacode/rescript-react-on-rails-example) for type-safe development |
154154

155155
> **Trusted by thousands** - See [real production sites](https://publicwww.com/websites/%22react-on-rails%22++-undeveloped.com+depth%3Aall/) using React on Rails
156156

0 commit comments

Comments
 (0)