Skip to content

Commit 7f18189

Browse files
justin808justin808
authored
Simplify the docs sidebar and Pro landing pages (#2909)
### Summary Simplify the docs information architecture by removing redundant top-level sidebar sections, regrouping Building Features, keeping Deployment visible, and nesting React Server Components under React on Rails Pro. Add release note archive pages and turn `home-pro` into a compatibility page so the sidebar can be simplified without changing existing doc routes. ### Pull Request checklist - [x] ~Add/update test to cover these changes~ - [x] Update documentation - [x] ~Update CHANGELOG file~ ### Other Information Validated with `pnpm exec eslint docs/sidebars.ts`, `pnpm exec prettier --check` on the changed files, and a doc-id existence check covering 105 sidebar references. I did not run a full Docusaurus build in this workspace. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk documentation-only changes, but navigation/doc-routing updates could cause broken links or missing sidebar entries if any doc IDs are incorrect. > > **Overview** > Simplifies the Docusaurus sidebar information architecture by removing the redundant “Choose a Path” section, regrouping `Building Features` into subcategories, consolidating `Configuration`/API docs under a new `Reference` section, and reshaping `Upgrading` into `Upgrading & Migration` with migration guides nested there. > > Adds stable archive index pages for OSS and Pro release notes (`upgrading/release-notes/index` and `pro/release-notes/index`) and updates the sidebar to point to these indexes plus the external `CHANGELOG.md`. > > Refactors Pro landing docs: turns `pro/home-pro` into a compatibility stub with quick links, and expands `pro/react-on-rails-pro` into the canonical entry with a route map, troubleshooting link, and pointers to the dummy app; nests React Server Components (and RSC migration docs) under the `React on Rails Pro` sidebar section. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 6e8cb1c. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added OSS and Pro release-notes archive pages with versioned links and full history pointers * Reorganized site navigation to consolidate reference content, merging release notes into migration/upgrading areas for easier discovery * Expanded Pro docs with a Route Map, troubleshooting link, fragment caching coverage, and consolidated reference links * Simplified Pro home to a compatibility notice with a canonical redirect and curated quick links <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 8f00ca9 commit 7f18189

5 files changed

Lines changed: 202 additions & 202 deletions

File tree

‎docs/oss/upgrading/release-notes/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_label: Release Notes Archive
3+
description: Archive of React on Rails OSS release notes that remain available at their existing routes.
4+
---
5+
6+
# React on Rails Release Notes
7+
8+
This archive keeps the major React on Rails OSS release notes easy to browse without listing every version directly in the sidebar.
9+
10+
## Recent OSS Release Notes
11+
12+
- [16.4.0](./16.4.0.md)
13+
- [16.3.0](./16.3.0.md)
14+
- [16.2.0](./16.2.0.md)
15+
- [16.1.0](./16.1.0.md)
16+
- [16.0.0](./16.0.0.md)
17+
- [15.0.0](./15.0.0.md)
18+
19+
## Full Version History
20+
21+
- [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md)

‎docs/pro/home-pro.md‎

Lines changed: 8 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,14 @@
1-
# React on Rails Pro
1+
# React on Rails Pro Home
22

3-
This is the canonical Pro landing page and route map. Start here if you are deciding whether to upgrade, then jump to the feature-specific entry page that matches your need.
3+
This route is kept for compatibility with older docs links.
44

5-
Node rendering, caching, streaming SSR, and React Server Components for [React on Rails](https://github.com/shakacode/react_on_rails). Check the [React on Rails CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md) for the latest version and upgrade notes.
5+
Use [React on Rails Pro](./react-on-rails-pro.md) as the canonical Pro landing page.
66

7-
## Route Map
8-
9-
| Need | Start here | Then read |
10-
| ----------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
11-
| Compare OSS and Pro | [OSS vs Pro comparison](../oss/getting-started/oss-vs-pro.md) | [Upgrade to Pro](./upgrading-to-pro.md) |
12-
| Dedicated Node.js SSR | [Node Renderer](./node-renderer.md) | [Node Renderer technical docs](../oss/building-features/node-renderer/basics.md) |
13-
| Progressive SSR | [Streaming SSR](./streaming-ssr.md) | [Streaming SSR guide](../oss/building-features/streaming-server-rendering.md) |
14-
| Cache rendered output | [Fragment Caching](./fragment-caching.md) | [SSR caching guide](../oss/building-features/caching.md) |
15-
| React Server Components | [RSC tutorial](./react-server-components/tutorial.md) | [Upgrade existing Pro app](./react-server-components/upgrading-existing-pro-app.md) |
16-
17-
## Getting Started
18-
19-
The best way to see how React on Rails Pro works is to install this repo locally and take a look at
20-
the example application:
21-
22-
[spec/dummy](https://github.com/shakacode/react_on_rails/blob/main/react_on_rails_pro/spec/dummy/README.md)
23-
24-
1. Uses a Shakapacker standard configuration.
25-
1. Has pages that demonstrate:
26-
1. caching
27-
2. loadable-components
28-
1. Has all the basic react_on_rails specs that run against the Node Renderer
29-
1. Demonstrates using HMR and loadable-components with almost the same example that is present in [loadable-components for SSR](https://github.com/gregberge/loadable-components/tree/main/examples/server-side-rendering)
30-
31-
See the README.md in those sample apps for more details.
32-
33-
## Features
34-
35-
### Node Renderer
36-
37-
The Pro Node Renderer replaces ExecJS with a dedicated Node.js server for 10-100x faster SSR, proper Node.js tooling, and memory isolation from the Ruby process. See the [Node Renderer overview](./node-renderer.md).
38-
39-
### Streaming SSR
40-
41-
Stream HTML to the browser progressively using React 18/19's `renderToPipeableStream`, so users see content as it becomes ready instead of waiting for the slowest component. See the [Streaming SSR overview](./streaming-ssr.md).
42-
43-
### Fragment Caching
44-
45-
Cache the complete rendered output of a component — including props assembly, serialization, and JavaScript evaluation — so that on a cache hit, none of that work happens. See the [Fragment Caching overview](./fragment-caching.md).
46-
47-
### React Server Components
48-
49-
Full RSC support with Rails integration. Server Components run on the server and stream their output to the client, reducing bundle size and enabling server-only data access. See the [RSC tutorial](./react-server-components/tutorial.md).
50-
51-
### Prerender Caching
52-
53-
Cache JavaScript evaluation results with a single config line (`config.prerender_caching = true`). See the [Caching guide](../oss/building-features/caching.md#level-1-prerender-caching).
54-
55-
### Code Splitting
56-
57-
Route-based code splitting with Loadable Components and SSR support. See [Code Splitting](../oss/building-features/code-splitting.md).
58-
59-
### Bundle Caching
60-
61-
Skip redundant webpack builds across deployments. See the [Bundle Caching docs](../oss/building-features/bundle-caching.md).
62-
63-
### Clearing of Global State
64-
65-
Set `config.ssr_pre_hook_js` to run JavaScript that clears globally leaked state at the beginning of each server render call. See [Rails Configuration](../oss/configuration/README.md).
66-
67-
## Other Utility Methods
68-
69-
See the [Ruby API](../oss/api-reference/ruby-api-pro.md).
70-
71-
## References
7+
## Quick Links
728

9+
- [React on Rails Pro](./react-on-rails-pro.md)
7310
- [Installation](./installation.md)
74-
- [Upgrading from OSS to Pro](./upgrading-to-pro.md)
75-
- [Node Renderer](./node-renderer.md)
11+
- [Upgrade from OSS to Pro](./upgrading-to-pro.md)
12+
- [React Server Components](./react-server-components/index.md)
7613
- [Streaming SSR](./streaming-ssr.md)
77-
- [Fragment Caching](./fragment-caching.md)
78-
- [React Server Components](./react-server-components/tutorial.md)
79-
- [Caching guide](../oss/building-features/caching.md)
80-
- [Rails Configuration](../oss/configuration/configuration-pro.md)
81-
- [Node Renderer technical docs](../oss/building-features/node-renderer/basics.md)
14+
- [Node Renderer](./node-renderer.md)

‎docs/pro/react-on-rails-pro.md‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# React on Rails Pro
22

3-
React on Rails Pro is the advanced rendering and performance tier for React on Rails. Start with the open-source integration, then add Pro when you need higher SSR throughput, React Server Components, streaming SSR, or dedicated Node renderer tooling.
3+
React on Rails Pro is the advanced rendering and performance tier for React on Rails. Start with the open-source integration, then add Pro when you need higher SSR throughput, React Server Components, streaming SSR, fragment caching, or dedicated Node renderer tooling.
44

55
## Start Here
66

7-
- [Pro docs home](./home-pro.md) - Canonical landing page for Pro feature docs
8-
- [Upgrade from OSS to Pro](./upgrading-to-pro.md) - Three-step upgrade path
97
- [Installation](./installation.md) - Fresh install or manual setup
8+
- [Upgrade from OSS to Pro](./upgrading-to-pro.md) - Three-step upgrade path
109
- [Configuration](../oss/configuration/configuration-pro.md) - Pro-specific runtime settings
10+
- [Troubleshooting](./troubleshooting.md) - Common setup and runtime issues
11+
12+
## Route Map
13+
14+
| Need | Start here | Then read |
15+
| ----------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------- |
16+
| Compare OSS and Pro | [OSS vs Pro comparison](../oss/getting-started/oss-vs-pro.md) | [Upgrade to Pro](./upgrading-to-pro.md) |
17+
| Dedicated Node.js SSR | [Node Renderer](./node-renderer.md) | [Node Renderer technical docs](../oss/building-features/node-renderer/basics.md) |
18+
| Progressive SSR | [Streaming SSR](./streaming-ssr.md) | [Streaming SSR guide](../oss/building-features/streaming-server-rendering.md) |
19+
| Cache rendered output | [Fragment Caching](./fragment-caching.md) | [SSR caching guide](../oss/building-features/caching.md) |
20+
| React Server Components | [RSC overview](./react-server-components/index.md) | [RSC tutorial](./react-server-components/tutorial.md) |
1121

1222
## What Pro Adds
1323

@@ -25,8 +35,21 @@ If your organization is budget-constrained, email [justin@shakacode.com](mailto:
2535

2636
See [Upgrading to Pro](./upgrading-to-pro.md#try-pro-risk-free) for the current licensing and upgrade details.
2737

28-
## Need Help?
38+
## Explore the Dummy App
39+
40+
The fastest way to understand how the Pro feature set fits together is to inspect the example app in this repo:
2941

30-
- [Docs home](./home-pro.md)
31-
- [Upgrade guide](./upgrading-to-pro.md)
42+
- [react_on_rails_pro/spec/dummy](https://github.com/shakacode/react_on_rails/blob/main/react_on_rails_pro/spec/dummy/README.md)
43+
44+
It demonstrates the Node renderer, caching, and SSR-oriented workflows in a real Rails app.
45+
46+
## References
47+
48+
- [Installation](./installation.md)
49+
- [Upgrade from OSS to Pro](./upgrading-to-pro.md)
50+
- [Node Renderer](./node-renderer.md)
51+
- [Streaming SSR](./streaming-ssr.md)
52+
- [Fragment Caching](./fragment-caching.md)
53+
- [React Server Components](./react-server-components/index.md)
54+
- [Pro configuration](../oss/configuration/configuration-pro.md)
3255
- [ShakaCode consulting](mailto:react_on_rails@shakacode.com)

‎docs/pro/release-notes/index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
sidebar_label: Pro Release Notes Archive
3+
description: Central index for React on Rails Pro release notes, including legacy pre-monorepo notes.
4+
---
5+
6+
# React on Rails Pro Release Notes
7+
8+
This archive provides one stable sidebar entry for Pro release notes without listing every version directly in navigation.
9+
10+
## Monorepo Era Release Notes
11+
12+
- [v4 React Server Components](./v4-react-server-components.md)
13+
14+
## Legacy (Pre-Monorepo) Release Notes
15+
16+
- [4.0](./4.0.md)
17+
18+
## Full Version History
19+
20+
- [CHANGELOG.md](https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md)

0 commit comments

Comments
 (0)