chore: generate markdown docs from jsdocs

remix-run-bot · remix-run-bot · commit bdf282c16646 · 2025-07-16T20:53:02.000Z
diff --git a/docs/api/rsc/RSCHydratedRouter.md b/docs/api/rsc/RSCHydratedRouter.md
@@ -5,20 +5,34 @@ unstable: true
 
 # unstable_RSCHydratedRouter
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rsc/browser.tsx
+-->
+
 [MODES: data]
 
 <br />
 <br />
 
-<docs-warning>This API is experimental and subject to breaking changes in
-minor/patch releases. Please use with caution and pay **very** close attention
+<docs-warning>This API is experimental and subject to breaking changes in 
+minor/patch releases. Please use with caution and pay **very** close attention 
 to release notes for relevant changes.</docs-warning>
 
 ## Summary
 
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_RSCHydratedRouter.html)
+
 Hydrates a server rendered `RSCPayload` in the browser.
 
-```tsx filename=entry.browser.tsx
+```tsx
 import { startTransition, StrictMode } from "react";
 import { hydrateRoot } from "react-dom/client";
 import {
@@ -49,20 +63,41 @@ createFromReadableStream(getRSCStream()).then(
 );
 ```
 
+## Signature
+
+```tsx
+function RSCHydratedRouter({
+  createFromReadableStream,
+  fetch: fetchImplementation = fetch,
+  payload,
+  routeDiscovery = "eager",
+  unstable_getContext,
+}: RSCHydratedRouterProps)
+```
+
 ## Props
 
 ### createFromReadableStream
 
-Your `react-server-dom-xyz/client`'s `createFromReadableStream` function, used to decode payloads from the server.
+Your `react-server-dom-xyz/client`'s `createFromReadableStream` function,
+used to decode payloads from the server.
+
+### fetch
+
+Optional fetch implementation.  Defaults to global `fetch`.
 
 ### payload
 
 The decoded `RSCPayload` to hydrate.
 
 ### routeDiscovery
 
-`eager` or `lazy` - Determines if links are eagerly discovered, or delayed until clicked.
+`eager` or `lazy` - Determines if links are eagerly discovered, or delayed
+until clicked.
 
 ### unstable_getContext
 
-A function that returns an `unstable_InitialContext` object (`Map<RouterContext, unknown>`), for use in client loaders, actions and middleware.
+A function that returns an `unstable_InitialContext` object
+(`Map<RouterContext, unknown>`), for use in client loaders, actions and
+middleware.
+
diff --git a/docs/api/rsc/RSCStaticRouter.md b/docs/api/rsc/RSCStaticRouter.md
@@ -5,22 +5,36 @@ unstable: true
 
 # unstable_RSCStaticRouter
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rsc/server.ssr.tsx
+-->
+
 [MODES: data]
 
 <br />
 <br />
 
-<docs-warning>This API is experimental and subject to breaking changes in
-minor/patch releases. Please use with caution and pay **very** close attention
+<docs-warning>This API is experimental and subject to breaking changes in 
+minor/patch releases. Please use with caution and pay **very** close attention 
 to release notes for relevant changes.</docs-warning>
 
 ## Summary
 
-Pre-renders an `RSCPayload` to HTML. Usually used in `routeRSCServerRequest`'s `renderHTML` callback.
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_RSCStaticRouter.html)
+
+Pre-renders an `RSCPayload` to HTML. Usually used in `routeRSCServerRequest`'s
+`renderHTML` callback.
 
-```tsx filename=entry.ssr.tsx
+```tsx
 import { createFromReadableStream } from "@vitejs/plugin-rsc/ssr";
-// @ts-expect-error
 import * as ReactDomServer from "react-dom/server.edge";
 import {
   unstable_RSCStaticRouter as RSCStaticRouter,
@@ -45,8 +59,16 @@ routeRSCServerRequest({
 });
 ```
 
+## Signature
+
+```tsx
+function RSCStaticRouter({ getPayload }: RSCStaticRouterProps)
+```
+
 ## Props
 
 ### getPayload
 
-A function that starts decoding of the `RSCPayload`. Usually passed through from `routeRSCServerRequest`'s `renderHTML`.
+A function that starts decoding of the `RSCPayload`. Usually passed through
+from `routeRSCServerRequest`'s `renderHTML`.
+
diff --git a/docs/api/rsc/createCallServer.md b/docs/api/rsc/createCallServer.md
@@ -5,20 +5,34 @@ unstable: true
 
 # unstable_createCallServer
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rsc/browser.tsx
+-->
+
 [MODES: data]
 
 <br />
 <br />
 
-<docs-warning>This API is experimental and subject to breaking changes in
-minor/patch releases. Please use with caution and pay **very** close attention
+<docs-warning>This API is experimental and subject to breaking changes in 
+minor/patch releases. Please use with caution and pay **very** close attention 
 to release notes for relevant changes.</docs-warning>
 
 ## Summary
 
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_createCallServer.html)
+
 Create a React `callServer` implementation for React Router.
 
-```tsx filename=entry.browser.tsx
+```tsx
 import {
   createFromReadableStream,
   createTemporaryReferenceSet,
@@ -36,12 +50,41 @@ setServerCallback(
 );
 ```
 
-## Options
+## Signature
+
+```tsx
+function createCallServer({
+  createFromReadableStream,
+  createTemporaryReferenceSet,
+  encodeReply,
+  fetch: fetchImplementation = fetch,
+}: {
+  createFromReadableStream: BrowserCreateFromReadableStreamFunction;
+  createTemporaryReferenceSet: () => unknown;
+  encodeReply: EncodeReplyFunction;
+  fetch?: (request: Request) => Promise<Response>;
+})
+```
+
+## Params
 
-### createFromReadableStream
+### opts.createFromReadableStream
 
 Your `react-server-dom-xyz/client`'s `createFromReadableStream`. Used to decode payloads from the server.
 
-### encodeReply
+### opts.createTemporaryReferenceSet
+
+A function that creates a temporary reference set for the RSC payload.
+
+### opts.encodeReply
 
 Your `react-server-dom-xyz/client`'s `encodeReply`. Used when sending payloads to the server.
+
+### opts.fetch
+
+Optional fetch implementation. Defaults to global `fetch`.
+
+## Returns
+
+A function that can be used to call server actions.
+
diff --git a/docs/api/rsc/getRSCStream.md b/docs/api/rsc/getRSCStream.md
@@ -5,20 +5,35 @@ unstable: true
 
 # unstable_getRSCStream
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rsc/html-stream/browser.ts
+-->
+
 [MODES: data]
 
 <br />
 <br />
 
-<docs-warning>This API is experimental and subject to breaking changes in
-minor/patch releases. Please use with caution and pay **very** close attention
+<docs-warning>This API is experimental and subject to breaking changes in 
+minor/patch releases. Please use with caution and pay **very** close attention 
 to release notes for relevant changes.</docs-warning>
 
 ## Summary
 
-Get the prerendered RSC stream for hydration. Usually passed directly to your `react-server-dom-xyz/client`'s `createFromReadableStream`.
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_getRSCStream.html)
+
+Get the prerendered RSC stream for hydration. Usually passed directly to your
+`react-server-dom-xyz/client`'s `createFromReadableStream`.
 
-```tsx filename=entry.browser.ts
+```tsx
 import { startTransition, StrictMode } from "react";
 import { hydrateRoot } from "react-dom/client";
 import {
@@ -33,13 +48,24 @@ createFromReadableStream(getRSCStream()).then(
       hydrateRoot(
         document,
         <StrictMode>
-          <RSCHydratedRouter /* props */ />
+          <RSCHydratedRouter ...props />
         </StrictMode>,
         {
-          /* ... */
+          // Options
         }
       );
     });
   }
 );
 ```
+
+## Signature
+
+```tsx
+function getRSCStream(): ReadableStream<any>
+```
+
+## Returns
+
+A `ReadableStream` that contains the RSC data for hydration.
+
diff --git a/docs/api/rsc/matchRSCServerRequest.md b/docs/api/rsc/matchRSCServerRequest.md
diff --git a/docs/api/rsc/routeRSCServerRequest.md b/docs/api/rsc/routeRSCServerRequest.md
