chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/hooks/useOutletContext.md

@@ -5,7 +5,7 @@ title: useOutletContext
 # useOutletContext
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -96,9 +96,10 @@ export default function DashboardMessages() {
 ## Signature
 
 ```tsx
-function useOutletContext<Context = unknown>(): Context;
+function useOutletContext<Context = unknown>(): Context
 ```
 
 ## Returns
 
 The context value passed to the parent [`Outlet`](../components/Outlet) component
+

docs/api/rsc/RSCHydratedRouter.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_RSCHydratedRouter
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -41,25 +41,19 @@ import {
 } from "react-router";
 import type { unstable_RSCPayload as RSCPayload } from "react-router";
 
-createFromReadableStream(getRSCStream()).then(
-  (payload: RSCServerPayload) => {
-    startTransition(async () => {
-      hydrateRoot(
-        document,
-        <StrictMode>
-          <RSCHydratedRouter
-            createFromReadableStream={
-              createFromReadableStream
-            }
-            payload={payload}
-          />
-        </StrictMode>,
-        {
-          formState: await getFormState(payload),
-        },
-      );
-    });
-  },
+createFromReadableStream(getRSCStream()).then((payload) =>
+  startTransition(async () => {
+    hydrateRoot(
+      document,
+      <StrictMode>
+        <RSCHydratedRouter
+          createFromReadableStream={createFromReadableStream}
+          payload={payload}
+        />
+      </StrictMode>,
+      { formState: await getFormState(payload) },
+    );
+  }),
 );
 ```
 
@@ -72,7 +66,7 @@ function RSCHydratedRouter({
   payload,
   routeDiscovery = "eager",
   unstable_getContext,
-}: RSCHydratedRouterProps);
+}: RSCHydratedRouterProps)
 ```
 
 ## Props
@@ -100,3 +94,4 @@ The decoded [`unstable_RSCPayload`](https://api.reactrouter.com/v7/types/react_r
 
 `"eager"` or `"lazy"` - Determines if links are eagerly discovered, or
 delayed until clicked.
+

docs/api/rsc/RSCStaticRouter.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_RSCStaticRouter
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -53,7 +53,7 @@ routeRSCServerRequest({
       {
         bootstrapScriptContent,
         formState: await getFormState(payload),
-      },
+      }
     );
   },
 });
@@ -62,9 +62,7 @@ routeRSCServerRequest({
 ## Signature
 
 ```tsx
-function RSCStaticRouter({
-  getPayload,
-}: RSCStaticRouterProps);
+function RSCStaticRouter({ getPayload }: RSCStaticRouterProps)
 ```
 
 ## Props
@@ -73,3 +71,4 @@ function RSCStaticRouter({
 
 A function that starts decoding of the [`unstable_RSCPayload`](https://api.reactrouter.com/v7/types/react_router.unstable_RSCPayload.html). Usually passed
 through from [`unstable_routeRSCServerRequest`](../rsc/routeRSCServerRequest)'s `renderHTML`.
+

docs/api/rsc/createCallServer.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_createCallServer
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -46,7 +46,7 @@ setServerCallback(
     createFromReadableStream,
     createTemporaryReferenceSet,
     encodeReply,
-  }),
+  })
 );
 ```
 
@@ -63,7 +63,7 @@ function createCallServer({
   createTemporaryReferenceSet: () => unknown;
   encodeReply: EncodeReplyFunction;
   fetch?: (request: Request) => Promise<Response>;
-});
+})
 ```
 
 ## Params
@@ -88,3 +88,4 @@ Optional [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
 ## Returns
 
 A function that can be used to call server actions.
+

docs/api/rsc/getRSCStream.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_getRSCStream
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -53,21 +53,22 @@ createFromReadableStream(getRSCStream()).then(
         </StrictMode>,
         {
           // Options
-        },
+        }
       );
     });
-  },
+  }
 );
 ```
 
 ## Signature
 
 ```tsx
-function getRSCStream(): ReadableStream<any>;
+function getRSCStream(): ReadableStream
 ```
 
 ## Returns
 
 A [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
 that contains the [RSC](https://react.dev/reference/rsc/server-components)
 data for hydration.
+

docs/api/rsc/matchRSCServerRequest.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_matchRSCServerRequest
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -60,7 +60,7 @@ matchRSCServerRequest({
       {
         status: match.statusCode,
         headers: match.headers,
-      },
+      }
     );
   },
 });
@@ -100,7 +100,7 @@ async function matchRSCServerRequest({
       temporaryReferences: unknown;
     },
   ) => Response;
-}): Promise<Response>;
+}): Promise<Response>
 ```
 
 ## Params
@@ -159,3 +159,4 @@ Your [route definitions](https://api.reactrouter.com/v7/types/react_router.unsta
 A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
 that contains the [RSC](https://react.dev/reference/rsc/server-components)
 data for hydration.
+

docs/api/rsc/routeRSCServerRequest.md

@@ -6,7 +6,7 @@ unstable: true
 # unstable_routeRSCServerRequest
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
 <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
@@ -55,7 +55,7 @@ routeRSCServerRequest({
       {
         bootstrapScriptContent,
         formState: await getFormState(payload),
-      },
+      }
     );
   },
 });
@@ -76,11 +76,9 @@ async function routeRSCServerRequest({
   createFromReadableStream: SSRCreateFromReadableStreamFunction;
   renderHTML: (
     getPayload: () => Promise<RSCPayload>,
-  ) =>
-    | ReadableStream<Uint8Array>
-    | Promise<ReadableStream<Uint8Array>>;
+  ) => ReadableStream<Uint8Array> | Promise<ReadableStream<Uint8Array>>;
   hydrate?: boolean;
-}): Promise<Response>;
+}): Promise<Response>
 ```
 
 ## Params
@@ -111,3 +109,4 @@ The request to route.
 A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
 that either contains the [RSC](https://react.dev/reference/rsc/server-components)
 payload for data requests, or renders the HTML for document requests.
+

docs/api/utils/createRoutesFromElements.md

@@ -5,7 +5,7 @@ title: createRoutesFromElements
 # createRoutesFromElements
 
 <!--
-⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
 Thank you for helping improve our documentation!
 
@@ -28,17 +28,9 @@ Create route objects from JSX elements instead of arrays of objects.
 const routes = createRoutesFromElements(
   <>
     <Route index loader={step1Loader} Component={StepOne} />
-    <Route
-      path="step-2"
-      loader={step2Loader}
-      Component={StepTwo}
-    />
-    <Route
-      path="step-3"
-      loader={step3Loader}
-      Component={StepThree}
-    />
-  </>,
+    <Route path="step-2" loader={step2Loader} Component={StepTwo} />
+    <Route path="step-3" loader={step3Loader} Component={StepThree} />
+  </>
 );
 
 const router = createBrowserRouter(routes);
@@ -62,3 +54,4 @@ application developer.
 ## Returns
 
 An array of [`RouteObject`](https://api.reactrouter.com/v7/types/react_router.RouteObject.html)s that can be used with a [`DataRouter`](https://api.reactrouter.com/v7/interfaces/react_router.DataRouter.html)
+