chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/data-routers/createBrowserRouter.md

@@ -73,8 +73,8 @@ application's data needs.
 
 The `dataStrategy` function should return a key/value-object of
 `routeId` -> [`DataStrategyResult`](https://api.reactrouter.com/v7/interfaces/react_router.DataStrategyResult.html) and should include entries for any
-routes where a handler was executed. A `DataStrategyResult` indicates
-if the handler was successful or not based on the `DataStrategyResult.type`
+routes where a handler was executed. A `DataStrategyResult` indicates if
+the handler was successful or not based on the `DataStrategyResult.type`
 field. If the returned `DataStrategyResult.result` is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
 React Router will unwrap it for you (via [`res.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json)
 or [`res.text`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text)).
@@ -238,11 +238,10 @@ Future flags to enable for the router.
 ### opts.unstable_getContext
 
 A function that returns an [`unstable_RouterContextProvider`](../utils/RouterContextProvider) instance
-which is provided as the `context` argument to client
-[`action`](../../start/data/route-object#action)s,
-[`loader`](../../start/data/route-object#loader)s and
-[`middleware`](../../how-to/middleware)s. This function is called to
-generate a fresh `context` instance on each navigation or fetcher call.
+which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+[`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+This function is called to generate a fresh `context` instance on each
+navigation or fetcher call.
 
 ### opts.hydrationData
 
@@ -270,15 +269,16 @@ server-rendered app. But in advanced use-cases (such as Framework Mode's
 [`clientLoader`](../../start/framework/route-module#clientLoader)), you may
 want to include `loaderData` for only some routes that were loaded/rendered
 on the server. This allows you to hydrate _some_ of the routes (such as the
-app layout/shell) while showing a `HydrateFallback`
-component and running the [`loader`](../../start/data/route-object#loader)s
-for other routes during hydration.
+app layout/shell) while showing a `HydrateFallback` component and running
+the [`loader`](../../start/data/route-object#loader)s for other routes
+during hydration.
 
 A route [`loader`](../../start/data/route-object#loader) will run during
 hydration in two scenarios:
 
  1. No hydration data is provided
-    In these cases the `HydrateFallback` component will render on initial hydration
+    In these cases the `HydrateFallback` component will render on initial
+    hydration
  2. The `loader.hydrate` property is set to `true`
     This allows you to run the [`loader`](../../start/data/route-object#loader)
     even if you did not render a fallback on initial hydration (i.e., to
@@ -349,11 +349,11 @@ the app - but would only ever end up loading portions of the tree that the
 user visited.
 
 `patchRoutesOnNavigation` will be called anytime React Router is unable to
-match a `path`. The arguments include the `path`, any partial
-`matches`, and a `patch` function you can call to patch
-new routes into the tree at a specific location. This method is executed
-during the `loading` portion of the navigation for `GET` requests and during
-the `submitting` portion of the navigation for non-`GET` requests.
+match a `path`. The arguments include the `path`, any partial `matches`,
+and a `patch` function you can call to patch new routes into the tree at a
+specific location. This method is executed during the `loading` portion of
+the navigation for `GET` requests and during the `submitting` portion of
+the navigation for non-`GET` requests.
 
 <details>
   <summary><b>Example <code>patchRoutesOnNavigation</code> Use Cases</b></summary>

docs/api/data-routers/createHashRouter.md

@@ -51,11 +51,10 @@ Future flags to enable for the router.
 ### opts.unstable_getContext
 
 A function that returns an [`unstable_RouterContextProvider`](../utils/RouterContextProvider) instance
-which is provided as the `context` argument to client
-[`action`](../../start/data/route-object#action)s,
-[`loader`](../../start/data/route-object#loader)s and
-[`middleware`](../../how-to/middleware)s. This function is called to
-generate a fresh `context` instance on each navigation or fetcher call.
+which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+[`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+This function is called to generate a fresh `context` instance on each
+navigation or fetcher call.
 
 ### opts.hydrationData
 
@@ -83,15 +82,16 @@ server-rendered app. But in advanced use-cases (such as Framework Mode's
 [`clientLoader`](../../start/framework/route-module#clientLoader)), you may
 want to include `loaderData` for only some routes that were loaded/rendered
 on the server. This allows you to hydrate _some_ of the routes (such as the
-app layout/shell) while showing a `HydrateFallback`
-component and running the [`loader`](../../start/data/route-object#loader)s
-for other routes during hydration.
+app layout/shell) while showing a `HydrateFallback` component and running
+the [`loader`](../../start/data/route-object#loader)s for other routes
+during hydration.
 
 A route [`loader`](../../start/data/route-object#loader) will run during
 hydration in two scenarios:
 
  1. No hydration data is provided
-    In these cases the `HydrateFallback` component will render on initial hydration
+    In these cases the `HydrateFallback` component will render on initial
+    hydration
  2. The `loader.hydrate` property is set to `true`
     This allows you to run the [`loader`](../../start/data/route-object#loader)
     even if you did not render a fallback on initial hydration (i.e., to
@@ -153,8 +153,8 @@ application's data needs.
 
 The `dataStrategy` function should return a key/value-object of
 `routeId` -> [`DataStrategyResult`](https://api.reactrouter.com/v7/interfaces/react_router.DataStrategyResult.html) and should include entries for any
-routes where a handler was executed. A `DataStrategyResult` indicates
-if the handler was successful or not based on the `DataStrategyResult.type`
+routes where a handler was executed. A `DataStrategyResult` indicates if
+the handler was successful or not based on the `DataStrategyResult.type`
 field. If the returned `DataStrategyResult.result` is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
 React Router will unwrap it for you (via [`res.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json)
 or [`res.text`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text)).
@@ -348,11 +348,11 @@ the app - but would only ever end up loading portions of the tree that the
 user visited.
 
 `patchRoutesOnNavigation` will be called anytime React Router is unable to
-match a `path`. The arguments include the `path`, any partial
-`matches`, and a `patch` function you can call to patch
-new routes into the tree at a specific location. This method is executed
-during the `loading` portion of the navigation for `GET` requests and during
-the `submitting` portion of the navigation for non-`GET` requests.
+match a `path`. The arguments include the `path`, any partial `matches`,
+and a `patch` function you can call to patch new routes into the tree at a
+specific location. This method is executed during the `loading` portion of
+the navigation for `GET` requests and during the `submitting` portion of
+the navigation for non-`GET` requests.
 
 <details>
   <summary><b>Example <code>patchRoutesOnNavigation</code> Use Cases</b></summary>

docs/api/data-routers/createMemoryRouter.md

@@ -56,8 +56,11 @@ Future flags to enable for the router.
 
 ### opts.unstable_getContext
 
-Function to provide the initial context values for all client side
-navigations/fetches
+A function that returns an [`unstable_RouterContextProvider`](../utils/RouterContextProvider) instance
+which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+[`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+This function is called to generate a fresh `context` instance on each
+navigation or fetcher call.
 
 ### opts.hydrationData
 

docs/api/rsc/RSCHydratedRouter.md

@@ -83,11 +83,10 @@ Optional fetch implementation. Defaults to global [`fetch`](https://developer.mo
 ### unstable_getContext
 
 A function that returns an [`unstable_RouterContextProvider`](../utils/RouterContextProvider) instance
-which is provided as the `context` argument to client
-[`action`](../../start/data/route-object#action)s,
-[`loader`](../../start/data/route-object#loader)s and
-[`middleware`](../../how-to/middleware)s. This function is called to
-generate a fresh `context` instance on each navigation or fetcher call.
+which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
+[`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
+This function is called to generate a fresh `context` instance on each
+navigation or fetcher call.
 
 ### payload
 

docs/api/utils/RouterContextProvider.md

@@ -31,7 +31,7 @@ to release notes for relevant changes.</docs-warning>
 [Reference Documentation ↗](https://api.reactrouter.com/v7/classes/react_router.unstable_RouterContextProvider.html)
 
 Provides methods for writing/reading values in application context in a
-type-safe way.  Primarily for usage with [Middleware](../../how-to/middleware).
+type-safe way. Primarily for usage with [middleware](../../how-to/middleware).
 
 ```tsx
 import {

docs/api/utils/createContext.md

@@ -30,15 +30,17 @@ to release notes for relevant changes.</docs-warning>
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_createContext.html)
 
-Creates a type-safe context object that can be used to store and retrieve
-values in middleware, [loaders](../../start/framework/route-module#loader),
-and [actions](../../start/framework/route-module#action). Similar to React's
-[`createContext`](https://react.dev/reference/react/createContext), but
-designed for React Router's request/response lifecycle.
+Creates a type-safe [`unstable_RouterContext`](https://api.reactrouter.com/v7/interfaces/react_router.unstable_RouterContext.html) object that can be used to
+* store and retrieve arbitrary values in [`action`](../../start/framework/route-module#action)s,
+* [`loader`](../../start/framework/route-module#loader)s, and [middleware](../../how-to/middleware).
+* Similar to React's [`createContext`](https://react.dev/reference/react/createContext),
+* but specifically designed for React Router's request/response lifecycle.
 
-If a `defaultValue` is provided, it will be returned from `context.get()` when
-no value has been set for the context. Otherwise reading this context when no
-value has been set will throw an error.
+<docs-warning>Enable this API with the `future.unstable_middleware` flag.</docs-warning>
+
+If a `defaultValue` is provided, it will be returned from `context.get()`
+when no value has been set for the context. Otherwise, reading this context
+when no value has been set will throw an error.
 
 ```tsx filename=app/context.ts
 import { unstable_createContext } from "react-router";
@@ -49,12 +51,12 @@ export const userContext =
 ```
 
 ```tsx filename=app/middleware/auth.ts
-import { userContext } from "~/context";
 import { getUserFromSession } from "~/auth.server";
+import { userContext } from "~/context";
 
 export const authMiddleware = async ({
-  request,
   context,
+  request,
 }) => {
   const user = await getUserFromSession(request);
   context.set(userContext, user);
@@ -94,5 +96,6 @@ An optional default value for the context. This value will be returned if no val
 ## Returns
 
 A [`unstable_RouterContext`](https://api.reactrouter.com/v7/interfaces/react_router.unstable_RouterContext.html) object that can be used with
-`context.get()` and `context.set()` in middleware, loaders, and actions.
+`context.get()` and `context.set()` in [`action`](../../start/framework/route-module#action)s,
+[`loader`](../../start/framework/route-module#loader)s, and [middleware](../../how-to/middleware).
 

docs/api/utils/data.md

@@ -22,18 +22,18 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/ro
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.data.html)
 
-Create "responses" that contain `status`/`headers` without forcing
-serialization into an actual `Response`
+Create "responses" that contain `headers`/`status` without forcing
+serialization into an actual [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
 
 ```tsx
 import { data } from "react-router";
 
-export async function action({ request }) {
+export async function action({ request }: Route.ActionArgs) {
   let formData = await request.formData();
   let item = await createItem(formData);
   return data(item, {
-    status: 201,
     headers: { "X-Custom-Header": "value" }
+    status: 201,
   });
 }
 ```
@@ -56,6 +56,6 @@ The status code or a `ResponseInit` object to be included in the response.
 
 ## Returns
 
-A `DataWithResponseInit` instance containing the data and response
-init.
+A `DataWithResponseInit` instance containing the data and
+response init.
 

docs/api/utils/isRouteErrorResponse.md

@@ -22,8 +22,9 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/ro
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.isRouteErrorResponse.html)
 
-Check if the given error is an ErrorResponse generated from a 4xx/5xx
-Response thrown from an action/loader
+Check if the given error is an [`ErrorResponse`](https://api.reactrouter.com/v7/types/react_router.ErrorResponse.html) generated from a 4xx/5xx
+[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+thrown from an [`action`](../../start/framework/route-module#action)/[`loader`](../../start/framework/route-module#loader)
 
 ```tsx
 import { isRouteErrorResponse } from "react-router";
@@ -32,7 +33,7 @@ export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
   if (isRouteErrorResponse(error)) {
     return (
       <>
-        <p>Error: {{error.status}: {error.statusText}}</p>
+        <p>Error: `${error.status}: ${error.statusText}`</p>
         <p>{error.data}</p>
       </>
     );
@@ -58,5 +59,5 @@ The error to check.
 
 ## Returns
 
-`true` if the error is an `ErrorResponse`, `false` otherwise.
+`true` if the error is an [`ErrorResponse`](https://api.reactrouter.com/v7/types/react_router.ErrorResponse.html), `false` otherwise.
 

docs/api/utils/matchPath.md

@@ -38,9 +38,9 @@ function matchPath<ParamKey extends ParamParseKey<Path>, Path extends string>(
 
 ### pattern
 
-The pattern to match against the URL pathname. This can be a string or a [`PathPattern`](https://api.reactrouter.com/v7/interfaces/react_router.PathPattern.html) object. If a string is provided, it will
-be treated as a pattern with `caseSensitive` set to `false` and `end
-set to `true`.
+The pattern to match against the URL pathname. This can be a string or a [`PathPattern`](https://api.reactrouter.com/v7/interfaces/react_router.PathPattern.html) object. If a string is provided, it will be
+treated as a pattern with `caseSensitive` set to `false` and `end` set to
+`true`.
 
 ### pathname
 

docs/api/utils/matchRoutes.md

@@ -63,7 +63,7 @@ The location to match against, either a string path or a partial [`Location`](ht
 
 ### basename
 
-Optional base path to strip from the location before matching.
+Optional base path to strip from the location before matching. Defaults to `/`.
 
 ## Returns