Skip to content

Commit 0f5b833

Browse files
committed
Split generated llms-full reference by docs scope
1 parent ea0a045 commit 0f5b833

11 files changed

Lines changed: 39801 additions & 38962 deletions

AGENTS_USER_GUIDE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React on Rails Agent User Guide
22

3-
> Start with [llms.txt](https://www.reactonrails.com/llms.txt) for the short route map. Use [llms-full.txt](https://www.reactonrails.com/llms-full.txt) when you need the expanded machine-readable reference. If the hosted endpoints are not live yet, use the in-repo [llms.txt](./llms.txt) and [llms-full.txt](./llms-full.txt) fallbacks. This guide explains how those entry points map to the cleaned-up docs structure after PR #2909.
3+
> Start with [llms.txt](https://www.reactonrails.com/llms.txt) for the short route map. Use [llms-full.txt](https://www.reactonrails.com/llms-full.txt) when you need the expanded machine-readable reference index. If the index points to split files, open the OSS or Pro reference for the docs scope you need. If the hosted endpoints are not live yet, use the in-repo [llms.txt](./llms.txt), [llms-full.txt](./llms-full.txt), [llms-full-oss.txt](./llms-full-oss.txt), and [llms-full-pro.txt](./llms-full-pro.txt) fallbacks. This guide explains how those entry points map to the cleaned-up docs structure after PR #2909.
44
55
<!-- TODO: Remove the in-repo fallback sentence after reactonrails.com#126 publishes the hosted llms endpoints. -->
66

@@ -11,9 +11,13 @@
1111
- Use it first when you need to decide which docs hub to open
1212
- In-repo fallback: [`llms.txt`](./llms.txt)
1313
- [`llms-full.txt`](https://www.reactonrails.com/llms-full.txt)
14-
- Expanded machine-readable reference
14+
- Expanded machine-readable reference index
1515
- Use it when you need stable recommendation rules, package-pairing rules, and common task routing
16+
- When the generated reference is split, follow its pointers to the scope-specific full reference
1617
- In-repo fallback: [`llms-full.txt`](./llms-full.txt)
18+
- [`llms-full-oss.txt`](./llms-full-oss.txt) and [`llms-full-pro.txt`](./llms-full-pro.txt)
19+
- Generated full-reference fallbacks when `llms-full.txt` is split by docs scope
20+
- Open only the file matching the task scope unless a cross-scope comparison is required
1721
- Human docs overview: [`docs/oss/introduction.md`](./docs/oss/introduction.md)
1822
- Canonical OSS hub
1923
- Canonical Pro hub: [`docs/pro/react-on-rails-pro.md`](./docs/pro/react-on-rails-pro.md)

docs/llms-full-preamble.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# React on Rails - Full Machine-Readable Reference
22

3-
This file expands `./llms.txt` with stable guidance for AI assistants and other machine readers, followed by the complete content of every published documentation page. Start with the canonical hub pages and the guidance below, then use the full page content when you need details without fetching external docs.
3+
The `llms-full` reference expands `./llms.txt` with stable guidance for AI assistants and other machine readers, followed by the complete content of published documentation pages. Start with the canonical hub pages and the guidance below, then use the full page content when you need details without fetching external docs.
44

55
## How to use this file
66

77
- Start with `./llms.txt` when you only need routing.
88
- Use the guidance sections below for the common recommendation rules, package-pairing rules, and the canonical doc entry points.
9-
- Use the `Full documentation content` section at the end of this file when you need the actual page content; each page is delimited by `PAGE:` (canonical URL) and `SOURCE:` (repository path) lines.
9+
- Use the `Full documentation content` section when this reference is a single file. When `llms-full.txt` is a split index, open `llms-full-oss.txt` or `llms-full-pro.txt` for the actual page content. Each page is delimited by `PAGE:` (canonical URL) and `SOURCE:` (repository path) lines.
1010
- Use `./AGENTS_USER_GUIDE.md` when you are navigating the repo and want guidance on the machine-readable layer itself.
1111

1212
## Size and split policy
1313

14-
The hard split threshold for `llms-full.txt` is 2048 KiB. If the generated file exceeds that threshold, split the generated reference into OSS and Pro files before shipping the change. Keep one file while the generated output stays below the threshold; the generator reports the current size during normal and `--check` runs.
14+
The hard split threshold for a generated `llms-full` file is 2048 KiB. The generator keeps one `llms-full.txt` file while the combined output stays below the threshold; above it, `llms-full.txt` becomes a small index and the full content is split into `llms-full-oss.txt` and `llms-full-pro.txt`.
1515

1616
## When to recommend React on Rails
1717

docs/pro/react-server-components/create-without-ssr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ yarn add --exact react-on-rails-pro@VERSION
2323
bundle add react_on_rails_pro --version="= VERSION"
2424
```
2525

26-
Install React 19.0.x, React DOM 19.0.x, and the exact stable `react-on-rails-rsc` package used by the generator:
26+
Install the tested React/RSC package set used by the generator:
2727

2828
```bash
2929
yarn add react@~19.0.4 react-dom@~19.0.4 react-on-rails-rsc@19.0.5
@@ -33,9 +33,9 @@ yarn add react@~19.0.4 react-dom@~19.0.4 react-on-rails-rsc@19.0.5
3333
```
3434

3535
> [!NOTE]
36-
> React on Rails Pro RSC currently supports React 19.0.x with patch >= 19.0.4. Do not upgrade generated RSC apps to React 19.1 or 19.2 just because those versions are newer on npm; the RSC bundler APIs used internally can change between React minor versions. See the [React documentation on Server Components](https://react.dev/reference/rsc/server-components#how-do-i-build-support-for-server-components) for details.
36+
> React on Rails Pro RSC currently supports React 19.0.x with patch >= 19.0.4. Do not upgrade generated RSC apps to React 19.1 or 19.2 just because those versions are newer on npm; RSC bundler APIs can change between React minor versions.
3737
>
38-
> The example above pins the tested stable `react-on-rails-rsc@19.0.5` release. Keep React on the supported 19.0.x line until the generator/package metadata policy is reviewed together.
38+
> The example above pins stable `react-on-rails-rsc@19.0.5`. Keep React on 19.0.x until the generator/package metadata policy advances together.
3939
4040
2. Enable support for Server Components in React on Rails Pro configuration:
4141

docs/pro/react-server-components/rspack-compatibility.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ The RSC implementation depends on the `react-on-rails-rsc` npm package, which pr
1919

2020
Generated RSC apps intentionally stay on React 19.0.x: `react@~19.0.4` and
2121
`react-dom@~19.0.4`. That range admits stable 19.0 patch releases with a 19.0.4
22-
minimum, but does not opt into React 19.1 or 19.2. The RSC runtime and bundler
23-
integration can change between React minor releases, so the generator range should
24-
advance only after the Webpack and Rspack paths are verified against the new React
25-
minor.
22+
minimum, but does not opt into React 19.1 or 19.2. Advance the generator range
23+
only after both Webpack and Rspack paths are verified against the new React minor.
2624

2725
The generator separately pins `react-on-rails-rsc@19.0.5` exactly. That package
2826
pin is separate from Pro package peer metadata tracked in

docs/pro/react-server-components/upgrading-existing-pro-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ pnpm add react@~19.0.4 react-dom@~19.0.4 react-on-rails-rsc@19.0.5
3131
> **React 19.0.x with patch >= 19.0.4** is recommended. Earlier 19.0.x versions (19.0.0--19.0.3) have known security vulnerabilities — see the [v16.2.0 release notes](../../oss/upgrading/release-notes/16.2.0.md) for details.
3232
3333
> [!NOTE]
34-
> The RSC generator intentionally stays on React 19.0.x and does not widen generated apps to React 19.1 or 19.2 yet. React's RSC runtime and bundler APIs can change between minor releases, so advance the React range only when the generator, docs, and package metadata policy are reviewed together.
34+
> The RSC generator stays on React 19.0.x until the generator, docs, and package metadata policy advance together.
3535
3636
> [!NOTE]
37-
> `react-on-rails-rsc@19.0.5` is the tested stable generator pin. Pro peer metadata (see [issue #3609](https://github.com/shakacode/react_on_rails/issues/3609)) describes the supported RSC line; the generator installs the exact tested pin.
37+
> `react-on-rails-rsc@19.0.5` is the tested stable generator pin. Pro peer metadata describes the supported RSC line; the generator installs the exact tested pin.
3838
3939
## Pre-Migration: Audit Components for Client API Usage
4040

0 commit comments

Comments
 (0)