Add agent summary blocks to high-value docs pages#3066
Merged
Conversation
Add standardized `> [!NOTE] Summary for AI agents` blocks to the task entry points referenced in llms.txt and AGENTS_USER_GUIDE.md that were missing them: quick-start, install-into-existing, oss-vs-pro, upgrading-to-pro, node-renderer, configuration, deployment, troubleshooting, upgrading, and migrating-to-rsc. This brings the total from 3 pages (introduction, Pro hub, RSC hub) to 13, completing the agent-readable routing layer for issue #2930. Closes #2930 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
WalkthroughTen key documentation pages across OSS and Pro sections now include standardized "Summary for AI agents" callout blocks at the top. Each callout concisely describes the page's purpose, target use cases, and routes to related pages to help agents navigate quickly and accurately. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR adds standardized Confidence Score: 5/5Safe to merge — documentation-only change with no code modifications All 10 files contain only documentation additions. All internal links in the new summary blocks were verified to point to existing files. No P0, P1, or blocking P2 findings were identified. No files require special attention Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[AI Agent receives user query] --> B{Intent?}
B -->|New Rails app setup| C[quick-start.md]
B -->|Existing app, add React| D[installation-into-an-existing-rails-app.md]
B -->|OSS vs Pro decision| E[oss-vs-pro.md]
B -->|Configuration options| F[configuration/README.md]
B -->|Deployment| G[deployment/README.md]
B -->|Troubleshooting| H[deployment/troubleshooting.md]
B -->|Version upgrade| I[upgrading-react-on-rails.md]
B -->|Upgrade OSS to Pro| J[pro/upgrading-to-pro.md]
B -->|Node renderer / SSR perf| K[pro/node-renderer.md]
B -->|RSC migration| L[migrating-to-rsc.md]
G --> M[docker-deployment.md]
G --> N[heroku-deployment.md]
G --> H
F --> O[configuration-pro.md]
Reviews (1): Last reviewed commit: "Add agent summary blocks to 10 high-valu..." | Re-trigger Greptile |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/oss/deployment/README.md (1)
4-4: Optional wording polish for readability.This sentence is clear, but the repeated “For …” structure reads a bit mechanical. Consider a compact rewrite for smoother flow.
Suggested rewrite
-> **Summary for AI agents:** Use this page to route to the correct deployment guide. For Docker/Kamal/Kubernetes/Control Plane, see [Docker Deployment](./docker-deployment.md). For Heroku, see [Heroku Deployment](./heroku-deployment.md). For SSR issues in production, see [Troubleshooting](./troubleshooting.md). +> **Summary for AI agents:** Use this page to route to the correct deployment guide: [Docker Deployment](./docker-deployment.md) for Docker/Kamal/Kubernetes/Control Plane, [Heroku Deployment](./heroku-deployment.md) for Heroku, and [Troubleshooting](./troubleshooting.md) for production SSR issues.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/oss/deployment/README.md` at line 4, The summary sentence in README.md is wordy due to repeated "For …" phrases; replace that single line with a more concise rewrite that groups destinations and reduces repetition (e.g., "Use this page to route to the correct deployment guide: Docker/Kamal/Kubernetes/Control Plane -> Docker Deployment, Heroku -> Heroku Deployment, and SSR production issues -> Troubleshooting.") — locate and update the line that starts "**Summary for AI agents:** Use this page to route to the correct deployment guide..." and replace it with a compact, smoother sentence or a short bulleted list linking to docker-deployment.md, heroku-deployment.md, and troubleshooting.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/oss/migrating/migrating-to-rsc.md`:
- Around line 5-7: The callout block starting with "[!NOTE]" contains a blank
line breaking the blockquote and triggering MD028; remove the empty line between
the "**Summary for AI agents:**..." line and the "RSC requires Pro..." line so
the blockquote remains continuous, keeping the same text order and punctuation
inside the blockquote that begins with "[!NOTE]".
In `@docs/pro/node-renderer.md`:
- Around line 5-7: The callout block beginning with "> [!NOTE]" contains a blank
line inside the blockquote which violates markdownlint MD028; fix it by removing
the empty line between the callout summary text and the following paragraph or
replace the empty line with a quoted blank line (a single ">" on its own) so the
entire callout remains a continuous blockquote; update the block that starts
with "> [!NOTE]" accordingly.
---
Nitpick comments:
In `@docs/oss/deployment/README.md`:
- Line 4: The summary sentence in README.md is wordy due to repeated "For …"
phrases; replace that single line with a more concise rewrite that groups
destinations and reduces repetition (e.g., "Use this page to route to the
correct deployment guide: Docker/Kamal/Kubernetes/Control Plane -> Docker
Deployment, Heroku -> Heroku Deployment, and SSR production issues ->
Troubleshooting.") — locate and update the line that starts "**Summary for AI
agents:** Use this page to route to the correct deployment guide..." and replace
it with a compact, smoother sentence or a short bulleted list linking to
docker-deployment.md, heroku-deployment.md, and troubleshooting.md.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e8ad1f26-9ae0-4f97-a53b-f173aab5e0f8
📒 Files selected for processing (10)
docs/oss/configuration/README.mddocs/oss/deployment/README.mddocs/oss/deployment/troubleshooting.mddocs/oss/getting-started/installation-into-an-existing-rails-app.mddocs/oss/getting-started/oss-vs-pro.mddocs/oss/getting-started/quick-start.mddocs/oss/migrating/migrating-to-rsc.mddocs/oss/upgrading/upgrading-react-on-rails.mddocs/pro/node-renderer.mddocs/pro/upgrading-to-pro.md
Comment on lines
+5
to
+7
| > [!NOTE] | ||
| > **Summary for AI agents:** Use this page when the user has an existing React on Rails app and wants to adopt RSC. This covers the React-side migration (component restructuring, state, data fetching). For the initial RSC setup, see the [RSC tutorial](../../pro/react-server-components/tutorial.md). RSC requires Pro with the Node renderer. | ||
|
|
Contributor
There was a problem hiding this comment.
Remove blank line inside callout blockquote (MD028).
Line 7 is a blank line within the blockquote; markdownlint flags this. Keep the blockquote continuous.
Suggested fix
> [!NOTE]
> **Summary for AI agents:** Use this page when the user has an existing React on Rails app and wants to adopt RSC. This covers the React-side migration (component restructuring, state, data fetching). For the initial RSC setup, see the [RSC tutorial](../../pro/react-server-components/tutorial.md). RSC requires Pro with the Node renderer.
-
+>
> **React on Rails Pro required:** RSC support requires [React on Rails Pro](../../pro/react-on-rails-pro.md) 4+ with the node renderer. The Pro gem provides the streaming view helpers (`stream_react_component`, `rsc_payload_react_component`), the RSC webpack plugin and loader, and the `registerServerComponent` API. For setup, see the [RSC tutorial](../../pro/react-server-components/tutorial.md). For upgrade steps, see the [performance breakthroughs guide](../../pro/major-performance-breakthroughs-upgrade-guide.md).🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 7-7: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/oss/migrating/migrating-to-rsc.md` around lines 5 - 7, The callout block
starting with "[!NOTE]" contains a blank line breaking the blockquote and
triggering MD028; remove the empty line between the "**Summary for AI
agents:**..." line and the "RSC requires Pro..." line so the blockquote remains
continuous, keeping the same text order and punctuation inside the blockquote
that begins with "[!NOTE]".
Comment on lines
+5
to
+7
| > [!NOTE] | ||
| > **Summary for AI agents:** Use this page when the user asks about the Node renderer, ExecJS alternatives, or SSR performance. This is the Pro-level overview; for technical setup, see [Node Renderer basics](../oss/building-features/node-renderer/basics.md) and [JS configuration](../oss/building-features/node-renderer/js-configuration.md). The Node renderer is required for RSC. | ||
|
|
Contributor
There was a problem hiding this comment.
Fix blockquote formatting to satisfy markdownlint MD028.
Line 7 introduces a blank line inside the callout blockquote, which trips no-blanks-blockquote. Use a quoted blank (>) or remove the blank line.
Suggested fix
> [!NOTE]
> **Summary for AI agents:** Use this page when the user asks about the Node renderer, ExecJS alternatives, or SSR performance. This is the Pro-level overview; for technical setup, see [Node Renderer basics](../oss/building-features/node-renderer/basics.md) and [JS configuration](../oss/building-features/node-renderer/js-configuration.md). The Node renderer is required for RSC.
-
+>
> **Route map**: Start at [React on Rails Pro](./react-on-rails-pro.md) if you're choosing a path. This page is the canonical Node Renderer overview; use the linked install and technical docs below for the deeper implementation details.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| > [!NOTE] | |
| > **Summary for AI agents:** Use this page when the user asks about the Node renderer, ExecJS alternatives, or SSR performance. This is the Pro-level overview; for technical setup, see [Node Renderer basics](../oss/building-features/node-renderer/basics.md) and [JS configuration](../oss/building-features/node-renderer/js-configuration.md). The Node renderer is required for RSC. | |
| > [!NOTE] | |
| > **Summary for AI agents:** Use this page when the user asks about the Node renderer, ExecJS alternatives, or SSR performance. This is the Pro-level overview; for technical setup, see [Node Renderer basics](../oss/building-features/node-renderer/basics.md) and [JS configuration](../oss/building-features/node-renderer/js-configuration.md). The Node renderer is required for RSC. | |
| > | |
| > **Route map**: Start at [React on Rails Pro](./react-on-rails-pro.md) if you're choosing a path. This page is the canonical Node Renderer overview; use the linked install and technical docs below for the deeper implementation details. |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 7-7: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/pro/node-renderer.md` around lines 5 - 7, The callout block beginning
with "> [!NOTE]" contains a blank line inside the blockquote which violates
markdownlint MD028; fix it by removing the empty line between the callout
summary text and the following paragraph or replace the empty line with a quoted
blank line (a single ">" on its own) so the entire callout remains a continuous
blockquote; update the block that starts with "> [!NOTE]" accordingly.
Contributor
Code ReviewDocumentation-only PR that adds Overall: looks good. The blocks are well-written, all internal links resolve to existing files, and the format is consistent with the 3 pre-existing blocks in What I checked
Minor observationThe PR description says these blocks "render as collapsed notes in Docusaurus." Worth clarifying: This doesn't affect the quality of the PR itself since the blocks are intentionally machine-readable hints, not UI elements. Just a doc-description nit. |
3 tasks
justin808
added a commit
that referenced
this pull request
Apr 8, 2026
…e-dedup * origin/main: (51 commits) Fix Content-Length mismatch and null renderingRequest errors in node renderer (#3069) Improve memory debugging docs with simpler heap snapshot approach (#3072) Enforce strict version matching in doctor and recommend doctor on errors (#3070) Remove immediate_hydration feature from codebase (#2834) Fix infinite fork loop when node renderer worker fails to bind port (#2881) Fix TanStack Router SSR hydration mismatch in Pro async path (#2932) Improve node renderer error messages for malformed render requests (#3068) Add interactive mode prompt to create-react-on-rails-app (#3063) docs: replace hardcoded version numbers with unversioned install commands (#2893) Remove Contributing section from docs sidebar (#3064) Consolidate docs comparison pages into single evaluation entry (#3065) Docs route cleanup: canonicalize worst verbose URL slugs (#3067) Add agent summary blocks to high-value docs pages (#3066) Fix brittle positional assertions in create-app tests (#2923) Auto-resolve renderer password from ENV in Rails Pro (#2921) Standardize bundle env vars from =yes to =true (#2925) Fix Pro generator multiline and template-literal rewrites (#2918) Fix spec/dummy Procfile.dev SERVER_BUNDLE_ONLY to match template convention (#2922) Add llms docs entry points (#2916) Bump version to 16.6.0.rc.0 ... # Conflicts: # packages/create-react-on-rails-app/src/create-app.ts
justin808
added a commit
that referenced
this pull request
Apr 8, 2026
…lacement-2835-main * origin/main: (44 commits) Fix Content-Length mismatch and null renderingRequest errors in node renderer (#3069) Improve memory debugging docs with simpler heap snapshot approach (#3072) Enforce strict version matching in doctor and recommend doctor on errors (#3070) Remove immediate_hydration feature from codebase (#2834) Fix infinite fork loop when node renderer worker fails to bind port (#2881) Fix TanStack Router SSR hydration mismatch in Pro async path (#2932) Improve node renderer error messages for malformed render requests (#3068) Add interactive mode prompt to create-react-on-rails-app (#3063) docs: replace hardcoded version numbers with unversioned install commands (#2893) Remove Contributing section from docs sidebar (#3064) Consolidate docs comparison pages into single evaluation entry (#3065) Docs route cleanup: canonicalize worst verbose URL slugs (#3067) Add agent summary blocks to high-value docs pages (#3066) Fix brittle positional assertions in create-app tests (#2923) Auto-resolve renderer password from ENV in Rails Pro (#2921) Standardize bundle env vars from =yes to =true (#2925) Fix Pro generator multiline and template-literal rewrites (#2918) Fix spec/dummy Procfile.dev SERVER_BUNDLE_ONLY to match template convention (#2922) Add llms docs entry points (#2916) Bump version to 16.6.0.rc.0 ... # Conflicts: # CHANGELOG.md
justin808
added a commit
that referenced
this pull request
Apr 8, 2026
### Summary Adds missing changelog entries to the `[Unreleased]` section for PRs merged since `v16.6.0.rc.0`. Analyzed 19 commits on `origin/main` since the last tag, identified 1 missing user-visible PR (#3069), and skipped 10 non-user-visible PRs (docs, tests, internal refactors). **New entries added:** - **Added**: `[Pro] Configurable HTTP keep-alive timeout for node renderer connections` (PR #3069) - **Fixed**: `[Pro] Fixed SSR failures from stale persistent HTTP/2 connections` (PR #3069) **Entries already present** (added in prior changelog updates): PRs #2834, #2881, #2918, #2921, #2923, #2932, #3063, #3068, #3070. **Skipped** (not user-visible): #2893 (docs), #2916 (docs), #2922 (test fix), #2923 (test fix), #2925 (internal refactor), #3064 (docs), #3065 (docs), #3066 (docs), #3067 (docs), #3072 (docs). ### Pull Request checklist - [x] ~Add/update test to cover these changes~ - [x] ~Update documentation~ - [x] Update CHANGELOG file ### Other Information No code changes — CHANGELOG.md only. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk because this PR only changes documentation (`CHANGELOG.md`) and does not modify runtime code. > > **Overview** > Updates `CHANGELOG.md` *[Unreleased]* to include missing Pro release notes for PR `#3069`, documenting the new `renderer_http_keep_alive_timeout` config and the associated fix for SSR failures from stale persistent HTTP/2 connections to the node renderer. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 8d1a480. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Interactive mode selection prompt for CLI tool when no explicit mode is specified * Configurable keep-alive timeout setting for Pro users (default 30 seconds) * **Bug Fixes** * Enhanced validation and error handling for invalid request payloads * Improved template literal handling in code generation * Better HTTP connection stability with enhanced diagnostic messaging <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 9, 2026
Adds missing changelog entries to the `[Unreleased]` section for PRs merged since `v16.6.0.rc.0`. Analyzed 19 commits on `origin/main` since the last tag, identified 1 missing user-visible PR (#3069), and skipped 10 non-user-visible PRs (docs, tests, internal refactors). **New entries added:** - **Added**: `[Pro] Configurable HTTP keep-alive timeout for node renderer connections` (PR #3069) - **Fixed**: `[Pro] Fixed SSR failures from stale persistent HTTP/2 connections` (PR #3069) **Entries already present** (added in prior changelog updates): PRs **Skipped** (not user-visible): #2893 (docs), #2916 (docs), #2922 (test fix), #2923 (test fix), #2925 (internal refactor), #3064 (docs), #3065 (docs), #3066 (docs), #3067 (docs), #3072 (docs). - [x] ~Add/update test to cover these changes~ - [x] ~Update documentation~ - [x] Update CHANGELOG file No code changes — CHANGELOG.md only. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk because this PR only changes documentation (`CHANGELOG.md`) and does not modify runtime code. > > **Overview** > Updates `CHANGELOG.md` *[Unreleased]* to include missing Pro release notes for PR `#3069`, documenting the new `renderer_http_keep_alive_timeout` config and the associated fix for SSR failures from stale persistent HTTP/2 connections to the node renderer. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 8d1a480. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **New Features** * Interactive mode selection prompt for CLI tool when no explicit mode is specified * Configurable keep-alive timeout setting for Pro users (default 30 seconds) * **Bug Fixes** * Enhanced validation and error handling for invalid request payloads * Improved template literal handling in code generation * Better HTTP connection stability with enhanced diagnostic messaging <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 9, 2026
Adds missing changelog entries to the `[Unreleased]` section for PRs merged since `v16.6.0.rc.0`. Analyzed 19 commits on `origin/main` since the last tag, identified 1 missing user-visible PR (#3069), and skipped 10 non-user-visible PRs (docs, tests, internal refactors). **New entries added:** - **Added**: `[Pro] Configurable HTTP keep-alive timeout for node renderer connections` (PR #3069) - **Fixed**: `[Pro] Fixed SSR failures from stale persistent HTTP/2 connections` (PR #3069) **Entries already present** (added in prior changelog updates): PRs **Skipped** (not user-visible): #2893 (docs), #2916 (docs), #2922 (test fix), #2923 (test fix), #2925 (internal refactor), #3064 (docs), #3065 (docs), #3066 (docs), #3067 (docs), #3072 (docs). - [x] ~Add/update test to cover these changes~ - [x] ~Update documentation~ - [x] Update CHANGELOG file No code changes — CHANGELOG.md only. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk because this PR only changes documentation (`CHANGELOG.md`) and does not modify runtime code. > > **Overview** > Updates `CHANGELOG.md` *[Unreleased]* to include missing Pro release notes for PR `#3069`, documenting the new `renderer_http_keep_alive_timeout` config and the associated fix for SSR failures from stale persistent HTTP/2 connections to the node renderer. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 8d1a480. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **New Features** * Interactive mode selection prompt for CLI tool when no explicit mode is specified * Configurable keep-alive timeout setting for Pro users (default 30 seconds) * **Bug Fixes** * Enhanced validation and error handling for invalid request payloads * Improved template literal handling in code generation * Better HTTP connection stability with enhanced diagnostic messaging <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
## Summary - Adds standardized `> [!NOTE] Summary for AI agents` blocks to the 10 highest-value task entry pages that were missing them - These are the "Start here" pages referenced in `llms.txt` and `AGENTS_USER_GUIDE.md` - Brings total coverage from 3 pages to 13, completing the agent-readable routing layer ## Pages updated 1. `docs/oss/getting-started/quick-start.md` 2. `docs/oss/getting-started/installation-into-an-existing-rails-app.md` 3. `docs/oss/getting-started/oss-vs-pro.md` 4. `docs/pro/upgrading-to-pro.md` 5. `docs/pro/node-renderer.md` 6. `docs/oss/configuration/README.md` 7. `docs/oss/deployment/README.md` 8. `docs/oss/deployment/troubleshooting.md` 9. `docs/oss/upgrading/upgrading-react-on-rails.md` 10. `docs/oss/migrating/migrating-to-rsc.md` ## What each block does Each summary block follows the existing pattern (`> [!NOTE] **Summary for AI agents:**`) and tells an agent: - When to use this page (user intent) - Where to route instead for adjacent intents - Key facts the agent needs to make correct recommendations These blocks render as collapsed notes in Docusaurus, so they don't affect the human reading experience. Closes #2930 ## Test plan - [ ] Verify the NOTE blocks render correctly in Docusaurus (they use GitHub-compatible admonition syntax) - [ ] Confirm no sidebar or navigation changes - [ ] Verify all internal links in the summary blocks resolve correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only change that adds standardized AI-routing note blocks; main risk is broken internal links or admonition rendering issues. > > **Overview** > Adds standardized `> [!NOTE]` **“Summary for AI agents”** blocks to 10 high-traffic OSS/Pro documentation entry pages (configuration, deployment, troubleshooting, getting started, upgrading, and RSC migration) to clarify *when to use the page* and where to route for adjacent intents. > > No product code changes; updates are limited to documentation content and internal cross-links. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit b94cc46. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Improved documentation navigation across OSS and Pro pages by adding clarifying notes for configuration, deployment, getting started, upgrading, and migration. * Added guidance to help users quickly locate relevant sections based on their specific integration scenarios and upgrade paths. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
### Summary Adds missing changelog entries to the `[Unreleased]` section for PRs merged since `v16.6.0.rc.0`. Analyzed 19 commits on `origin/main` since the last tag, identified 1 missing user-visible PR (#3069), and skipped 10 non-user-visible PRs (docs, tests, internal refactors). **New entries added:** - **Added**: `[Pro] Configurable HTTP keep-alive timeout for node renderer connections` (PR #3069) - **Fixed**: `[Pro] Fixed SSR failures from stale persistent HTTP/2 connections` (PR #3069) **Entries already present** (added in prior changelog updates): PRs #2834, #2881, #2918, #2921, #2923, #2932, #3063, #3068, #3070. **Skipped** (not user-visible): #2893 (docs), #2916 (docs), #2922 (test fix), #2923 (test fix), #2925 (internal refactor), #3064 (docs), #3065 (docs), #3066 (docs), #3067 (docs), #3072 (docs). ### Pull Request checklist - [x] ~Add/update test to cover these changes~ - [x] ~Update documentation~ - [x] Update CHANGELOG file ### Other Information No code changes — CHANGELOG.md only. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk because this PR only changes documentation (`CHANGELOG.md`) and does not modify runtime code. > > **Overview** > Updates `CHANGELOG.md` *[Unreleased]* to include missing Pro release notes for PR `#3069`, documenting the new `renderer_http_keep_alive_timeout` config and the associated fix for SSR failures from stale persistent HTTP/2 connections to the node renderer. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 8d1a480. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Interactive mode selection prompt for CLI tool when no explicit mode is specified * Configurable keep-alive timeout setting for Pro users (default 30 seconds) * **Bug Fixes** * Enhanced validation and error handling for invalid request payloads * Improved template literal handling in code generation * Better HTTP connection stability with enhanced diagnostic messaging <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
## Summary - Adds standardized `> [!NOTE] Summary for AI agents` blocks to the 10 highest-value task entry pages that were missing them - These are the "Start here" pages referenced in `llms.txt` and `AGENTS_USER_GUIDE.md` - Brings total coverage from 3 pages to 13, completing the agent-readable routing layer ## Pages updated 1. `docs/oss/getting-started/quick-start.md` 2. `docs/oss/getting-started/installation-into-an-existing-rails-app.md` 3. `docs/oss/getting-started/oss-vs-pro.md` 4. `docs/pro/upgrading-to-pro.md` 5. `docs/pro/node-renderer.md` 6. `docs/oss/configuration/README.md` 7. `docs/oss/deployment/README.md` 8. `docs/oss/deployment/troubleshooting.md` 9. `docs/oss/upgrading/upgrading-react-on-rails.md` 10. `docs/oss/migrating/migrating-to-rsc.md` ## What each block does Each summary block follows the existing pattern (`> [!NOTE] **Summary for AI agents:**`) and tells an agent: - When to use this page (user intent) - Where to route instead for adjacent intents - Key facts the agent needs to make correct recommendations These blocks render as collapsed notes in Docusaurus, so they don't affect the human reading experience. Closes #2930 ## Test plan - [ ] Verify the NOTE blocks render correctly in Docusaurus (they use GitHub-compatible admonition syntax) - [ ] Confirm no sidebar or navigation changes - [ ] Verify all internal links in the summary blocks resolve correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only change that adds standardized AI-routing note blocks; main risk is broken internal links or admonition rendering issues. > > **Overview** > Adds standardized `> [!NOTE]` **“Summary for AI agents”** blocks to 10 high-traffic OSS/Pro documentation entry pages (configuration, deployment, troubleshooting, getting started, upgrading, and RSC migration) to clarify *when to use the page* and where to route for adjacent intents. > > No product code changes; updates are limited to documentation content and internal cross-links. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit b94cc46. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Improved documentation navigation across OSS and Pro pages by adding clarifying notes for configuration, deployment, getting started, upgrading, and migration. * Added guidance to help users quickly locate relevant sections based on their specific integration scenarios and upgrade paths. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
justin808
added a commit
that referenced
this pull request
Apr 12, 2026
### Summary Adds missing changelog entries to the `[Unreleased]` section for PRs merged since `v16.6.0.rc.0`. Analyzed 19 commits on `origin/main` since the last tag, identified 1 missing user-visible PR (#3069), and skipped 10 non-user-visible PRs (docs, tests, internal refactors). **New entries added:** - **Added**: `[Pro] Configurable HTTP keep-alive timeout for node renderer connections` (PR #3069) - **Fixed**: `[Pro] Fixed SSR failures from stale persistent HTTP/2 connections` (PR #3069) **Entries already present** (added in prior changelog updates): PRs #2834, #2881, #2918, #2921, #2923, #2932, #3063, #3068, #3070. **Skipped** (not user-visible): #2893 (docs), #2916 (docs), #2922 (test fix), #2923 (test fix), #2925 (internal refactor), #3064 (docs), #3065 (docs), #3066 (docs), #3067 (docs), #3072 (docs). ### Pull Request checklist - [x] ~Add/update test to cover these changes~ - [x] ~Update documentation~ - [x] Update CHANGELOG file ### Other Information No code changes — CHANGELOG.md only. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk because this PR only changes documentation (`CHANGELOG.md`) and does not modify runtime code. > > **Overview** > Updates `CHANGELOG.md` *[Unreleased]* to include missing Pro release notes for PR `#3069`, documenting the new `renderer_http_keep_alive_timeout` config and the associated fix for SSR failures from stale persistent HTTP/2 connections to the node renderer. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 8d1a480. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Interactive mode selection prompt for CLI tool when no explicit mode is specified * Configurable keep-alive timeout setting for Pro users (default 30 seconds) * **Bug Fixes** * Enhanced validation and error handling for invalid request payloads * Improved template literal handling in code generation * Better HTTP connection stability with enhanced diagnostic messaging <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
> [!NOTE] Summary for AI agentsblocks to the 10 highest-value task entry pages that were missing themllms.txtandAGENTS_USER_GUIDE.mdPages updated
docs/oss/getting-started/quick-start.mddocs/oss/getting-started/installation-into-an-existing-rails-app.mddocs/oss/getting-started/oss-vs-pro.mddocs/pro/upgrading-to-pro.mddocs/pro/node-renderer.mddocs/oss/configuration/README.mddocs/oss/deployment/README.mddocs/oss/deployment/troubleshooting.mddocs/oss/upgrading/upgrading-react-on-rails.mddocs/oss/migrating/migrating-to-rsc.mdWhat each block does
Each summary block follows the existing pattern (
> [!NOTE] **Summary for AI agents:**) and tells an agent:These blocks render as collapsed notes in Docusaurus, so they don't affect the human reading experience.
Closes #2930
Test plan
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change that adds standardized AI-routing note blocks; main risk is broken internal links or admonition rendering issues.
Overview
Adds standardized
> [!NOTE]“Summary for AI agents” blocks to 10 high-traffic OSS/Pro documentation entry pages (configuration, deployment, troubleshooting, getting started, upgrading, and RSC migration) to clarify when to use the page and where to route for adjacent intents.No product code changes; updates are limited to documentation content and internal cross-links.
Reviewed by Cursor Bugbot for commit b94cc46. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit