chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/data-routers/createBrowserRouter.md

@@ -73,7 +73,7 @@ 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`](https://api.reactrouter.com/v7/interfaces/react_router.DataStrategyResult.html) indicates
+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)
@@ -266,16 +266,15 @@ 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``
+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
@@ -347,7 +346,7 @@ 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
+`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.
@@ -450,7 +449,7 @@ the `submitting` portion of the navigation for non-`GET` requests.
   **Co-locating route discovery with route definition**
 
   If you don't wish to perform your own pseudo-matching, you can leverage
-  the partial ``matches`` array and the [`handle`](../../start/data/route-object#handle)
+  the partial `matches` array and the [`handle`](../../start/data/route-object#handle)
   field on a route to keep the children definitions co-located:
 
   ```tsx

docs/api/data-routers/createHashRouter.md

@@ -79,16 +79,15 @@ 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``
+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
@@ -150,7 +149,7 @@ 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`](https://api.reactrouter.com/v7/interfaces/react_router.DataStrategyResult.html) indicates
+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)
@@ -346,7 +345,7 @@ 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
+`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.
@@ -449,7 +448,7 @@ the `submitting` portion of the navigation for non-`GET` requests.
   **Co-locating route discovery with route definition**
 
   If you don't wish to perform your own pseudo-matching, you can leverage
-  the partial ``matches`` array and the [`handle`](../../start/data/route-object#handle)
+  the partial `matches` array and the [`handle`](../../start/data/route-object#handle)
   field on a route to keep the children definitions co-located:
 
   ```tsx

docs/api/utils/RouterContextProvider.md

@@ -0,0 +1,48 @@
+---
+title: RouterContextProvider
+unstable: true
+---
+
+# unstable_RouterContextProvider
+
+<!--
+⚠️ ⚠️ 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/router/utils.ts
+-->
+
+[MODES: framework, 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 
+to release notes for relevant changes.</docs-warning>
+
+## Summary
+
+[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).
+
+```tsx
+import {
+  unstable_createContext,
+  unstable_RouterContextProvider
+} from "react-router";
+
+const userContext = unstable_createContext<User | null>(null);
+const contextProvider = new unstable_RouterContextProvider();
+contextProvider.set(userContext, getUser());
+const user = contextProvider.get(userContext);
+//    ^ User
+```
+

docs/api/utils/createContext.md

@@ -5,38 +5,40 @@ unstable: true
 
 # unstable_createContext
 
-[MODES: framework, data]
-
-<br/>
-<br/>
-
-<docs-warning>This API is experimental and subject to breaking changes. Enable it with the `future.unstable_middleware` flag.</docs-warning>
-
-## Summary
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
 
-[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_createContext.html)
+Thank you for helping improve our documentation!
 
-Creates a type-safe context object that can be used to store and retrieve values in middleware, loaders, and actions. Similar to React's `createContext`, but designed for React Router's request/response lifecycle.
+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.
 
-## Signature
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/router/utils.ts
+-->
 
-```tsx
-unstable_createContext<T>(defaultValue?: T): RouterContext<T>
-```
+[MODES: framework, data]
 
-## Params
+<br />
+<br />
 
-### defaultValue
+<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>
 
-An optional default value for the context. This value will be returned if no value has been set for this context.
-
-## Returns
+## Summary
 
-A `RouterContext<T>` object that can be used with `context.get()` and `context.set()` in middleware, loaders, and actions.
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_createContext.html)
 
-## Examples
+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.
 
-### Basic Usage
+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";
@@ -75,6 +77,22 @@ export async function loader({
 }
 ```
 
-## See Also
+## Signature
+
+```tsx
+function unstable_createContext<T>(
+  defaultValue?: T,
+): unstable_RouterContext<T>
+```
+
+## Params
+
+### defaultValue
+
+An optional default value for the context. This value will be returned if no value has been set for this context.
+
+## 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.
 
-- [Middleware Guide](../../how-to/middleware)

docs/api/utils/data.md

@@ -4,31 +4,58 @@ title: data
 
 # data
 
+<!--
+⚠️ ⚠️ 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/router/utils.ts
+-->
+
 [MODES: framework, data]
 
 ## Summary
 
 [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` - used by Remix single fetch
+serialization into an actual `Response`
+
+```tsx
+import { data } from "react-router";
+
+export async function action({ request }) {
+  let formData = await request.formData();
+  let item = await createItem(formData);
+  return data(item, {
+    status: 201,
+    headers: { "X-Custom-Header": "value" }
+  });
+}
+```
 
 ## Signature
 
 ```tsx
-data(data, init): DataWithResponseInit
+function data<D>(data: D, init?: number | ResponseInit)
 ```
 
 ## Params
 
 ### data
 
-[modes: framework, data]
-
-_No documentation_
+The data to be included in the response.
 
 ### init
 
-[modes: framework, data]
+The status code or a `ResponseInit` object to be included in the response.
+
+## Returns
+
+A `DataWithResponseInit` instance containing the data and response
+init.
 
-_No documentation_

docs/api/utils/generatePath.md

@@ -4,6 +4,18 @@ title: generatePath
 
 # generatePath
 
+<!--
+⚠️ ⚠️ 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/router/utils.ts
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
@@ -12,22 +24,34 @@ title: generatePath
 
 Returns a path with params interpolated.
 
+```tsx
+import { generatePath } from "react-router";
+
+generatePath("/users/:id", { id: "123" }); // "/users/123"
+```
+
 ## Signature
 
 ```tsx
-generatePath(originalPath, params): string
+function generatePath<Path extends string>(
+  originalPath: Path,
+  params: {
+    [key in PathParam<Path>]: string | null;
+  } =  as any,
+): string {}
 ```
 
 ## Params
 
 ### originalPath
 
-[modes: framework, data, declarative]
-
-_No documentation_
+The original path to generate.
 
 ### params
 
-[modes: framework, data, declarative]
+The parameters to interpolate into the path.
+
+## Returns
+
+The generated path with parameters interpolated.
 
-_No documentation_