Skip to content

docs: framework Connect guides, reachable SDK nav, "Start the server" - #1437

Open
yuvrxj-afk wants to merge 1 commit into
feat/reconnect-errorfrom
docs/connect-framework-guides
Open

docs: framework Connect guides, reachable SDK nav, "Start the server"#1437
yuvrxj-afk wants to merge 1 commit into
feat/reconnect-errorfrom
docs/connect-framework-guides

Conversation

@yuvrxj-afk

Copy link
Copy Markdown
Collaborator

Follow-up to #1209 (stacked on it — the Corsair Connect docs it adds are the base for this). Retarget to main once #1209 merges.

Framework guides — a Corsair Connect example in the Next, Remix, and TanStack guides, each wired to that framework's own refresh:

  • Next → router.refresh()
  • Remix → useRevalidator().revalidate() (provider in app/root.tsx)
  • TanStack → 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 there call and connect are 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.json validated as JSON; every new link resolves.

- 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.
@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
www Ready Ready Preview Aug 31, 2026 2:37pm

Request Review

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 89b2f326-297c-4e3b-ae65-a5bad3e3d903

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the docs Docs / Mintlify / markdown changes label Aug 31, 2026
@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This docs-only PR expands Corsair Connect guidance and improves reference-page discoverability.

  • Adds framework-specific post-connect refresh examples for Next.js, Remix, and TanStack Start.
  • Adds the handler, vanilla client, and React adapter pages to an SDK navigation group.
  • Documents the CorsairBoundary provider requirement and consistently renames setup sections to “Start the server.”

Confidence Score: 5/5

The 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

Filename Overview
docs/frameworks/next.mdx Adds a CorsairProvider example that refreshes Next.js Server Component reads after connection.
docs/frameworks/remix.mdx Adds root-provider guidance using Remix loader revalidation after connection.
docs/frameworks/tanstack.mdx Adds root-provider guidance using TanStack Router invalidation after connection.
docs/adapters/react.mdx Clarifies that CorsairBoundary requires a CorsairProvider ancestor.
docs/docs.json Makes the handler, client, and React adapter references reachable through a new SDK group.

Reviews (1): Last reviewed commit: "docs: framework Connect guides, reachabl..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Docs / Mintlify / markdown changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant