Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Repo admins can enable using credits for code reviews in their settings.

Walkthrough

Documentation updates addressing RSC adoption gaps: added guidance for handling non-serializable functions in railsContext when crossing RSC boundaries, clarified transpiled language component directive placement, documented compression middleware streaming compatibility, and expanded RSC troubleshooting error catalog with JSON parsing and railsContext-related issues.

Changes

Poem

🐰 In burrows deep where docs now gleam,
RSC whispers, no longer a dream.
Functions that shadow must now step aside,
Transpilers tamed with a simple guide.
Streaming flows smooth—no deadlock dismay!
Migration gaps filled, we hop on our way! ✨

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

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 @coderabbitai help to get the list of available commands and usage tips.}

Greptile Summary

This PR fills documentation gaps discovered during a real-world RSC migration, covering ReScript/transpiled-language 'use client' placement, compression middleware deadlock warnings, and railsContext function serialization errors. The additions are accurate and directly useful, but one link is broken.

• New ReScript guidance (rsc-preparing-app.md): Correctly explains that 'use client' must go on the wrapper .jsx files in ror_components/, not the compiled .bs.js files, and warns about silent misclassification. Content is accurate.
• Compression middleware warning (rsc-preparing-app.md): The warning itself is correct, but the cross-reference link points to ../building-features/streaming-server-rendering.md#compression-middleware-compatibility — an anchor that does not exist in that file. The section lives in docs/pro/streaming-ssr.md; the correct relative path from docs/oss/migrating/ is ../../pro/streaming-ssr.md#compression-middleware-compatibility.
• railsContext functions section (rsc-troubleshooting.md + render-functions-and-railscontext.md): Accurately describes the addPostSSRHook/getRSCPayloadStream serialization problem and the destructuring fix. The thunk (return () => (...)) in the code example is correct for React on Rails render functions but may be briefly worth annotating in the RSC troubleshooting context.
• Error catalog entries (rsc-troubleshooting.md): Both new rows are well-written and link to the right sections.

Confidence Score: 4/5

• Safe to merge after fixing the broken anchor link in the compression middleware warning.
• All documentation additions are accurate and fill real gaps. The only concrete issue is a broken anchor link that would silently drop readers at the top of the OSS streaming page instead of the actual fix — a one-line change resolves it. Everything else is clean.
• docs/oss/migrating/rsc-preparing-app.md — the compression middleware cross-reference link needs to be updated to point to the Pro streaming-ssr.md anchor.

Important Files Changed

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Server Component render function\n(props, railsContext)"] --> B{"Does railsContext\ncontain functions?"}
    B -- "Yes (Pro: addPostSSRHook,\ngetRSCPayloadStream)" --> C["Destructure: strip\nnon-serializable keys"]
    C --> D["Pass serializableContext\nto Client Component"]
    B -- "No functions" --> D
    D --> E["RSC boundary ✅\nClient Component receives\nplain-object railsContext"]

    F["Wrapper .jsx file\n(ror_components/)"] --> G{"Language?"}
    G -- "JS/TS" --> H["Add 'use client'\nto .jsx/.tsx"]
    G -- "ReScript/Reason" --> I["Add 'use client'\nto .client.jsx and\n.server.jsx wrappers\nNOT .bs.js compiled files"]
    H --> J["Pack generator registers\nas Client Component ✅"]
    I --> J
    K["Missing 'use client'"] --> L["Silently registered as\nServer Component ❌\nBreaks at runtime"]

_{Reviews (1): Last reviewed commit: "Docs: fix RSC migration gaps found durin..." | Re-trigger Greptile}

Review: Docs — RSC migration gaps

The additions address real, silent failure points and the troubleshooting table entries are a welcome improvement. Three issues worth fixing before merge:

Must fix

1. Broken link + misleading compression warning (rsc-preparing-app.md line 485) — The anchor #compression-middleware-compatibility does not exist in streaming-server-rendering.md (OSS); it lives in docs/pro/streaming-ssr.md. Additionally the warning implies that any use of Rack::Deflater/Rack::Brotli causes deadlocks, but the Pro doc (line 168) says these middlewares work correctly with streaming by default — the deadlock only occurs with specific :if conditions that call body.each. See inline comment for a suggested fix.

Should fix

2. Render function code pattern needs a comment (rsc-troubleshooting.md lines 116-123) — The return () => (...) idiom is the React on Rails render-function-returns-a-component pattern, which is different from the async function Page() style used elsewhere in the file. Without explanation the reader cannot tell which pattern applies to them. See inline comment.

3. Hardcoded non-serializable function names may go stale (render-functions-and-railscontext.md line 116) — The destructuring fix enumerates exactly addPostSSRHook and getRSCPayloadStream. If Pro adds another non-serializable key in a future release, the snippet silently becomes incomplete. Consider noting these are the currently known keys and/or showing the type-filter alternative. See inline comment.

Looks good

• The ReScript wrapper explanation and the "silent misclassification" warning are accurate and fill a genuine gap — the existing context at lines 443-447 makes the use client on .server.jsx correct and intentional.
• The view-annotations error catalog entry is accurate with the right version fix (Pro 16.4.0+).
• The railsContext Contains Functions troubleshooting section is well-structured.