docs: framework Connect guides, reachable SDK nav, "Start the server" - #1437
docs: framework Connect guides, reachable SDK nav, "Start the server"#1437yuvrxj-afk wants to merge 1 commit into
Conversation
- Add a Corsair Connect example to the Next, Remix, and TanStack guides, each wired to that framework's own refresh (router.refresh / useRevalidator / router.invalidate). Note that the <CorsairBoundary> read helper is specific to Next Server Components — Remix and TanStack read in loaders. - Surface the orphaned SDK reference pages (handlers, client, react) under a collapsible SDK group in the sidebar, so Corsair Connect is reachable. - Note that <CorsairBoundary> needs a <CorsairProvider> ancestor. - Rename the "Go green" verify heading to "Start the server" across the framework and handler guides.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 docs-only PR expands Corsair Connect guidance and improves reference-page discoverability.
Confidence Score: 5/5The documentation changes appear safe to merge, with no concrete incorrect or unreachable guidance established. The added framework refresh callbacks match the provider contract, the SDK navigation entries target existing pages, and the remaining edits are consistent terminology and provider-context clarification. Important Files Changed
Reviews (1): Last reviewed commit: "docs: framework Connect guides, reachabl..." | Re-trigger Greptile |
Follow-up to #1209 (stacked on it — the Corsair Connect docs it adds are the base for this). Retarget to
mainonce #1209 merges.Framework guides — a Corsair Connect example in the Next, Remix, and TanStack guides, each wired to that framework's own refresh:
router.refresh()useRevalidator().revalidate()(provider inapp/root.tsx)router.invalidate()(provider in the root route)Each notes that the
<CorsairBoundary>read helper is Next-RSC-specific — Remix and TanStack read in loaders, so therecallandconnectare the surfaces that apply.Reachability — the SDK reference pages (
adapters/handlers,adapters/client,adapters/react) were orphaned (not in the sidebar), which hid Corsair Connect. Added them under a collapsible SDK group in Reference.Boundary note —
<CorsairBoundary>reads provider context and throws without a<CorsairProvider>ancestor; the docs now say so."Go green" → "Start the server" across the framework + handler guides. The body still points at the App-sync dot as the success signal.
Docs-only.
docs.jsonvalidated as JSON; every new link resolves.