chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/data-routers/createBrowserRouter.md

@@ -243,12 +243,29 @@ which is provided as the `context` argument to client [`action`](../../start/dat
 This function is called to generate a fresh `context` instance on each
 navigation or fetcher call.
 
+```tsx
+import {
+  unstable_createContext,
+  unstable_RouterContextProvider,
+} from "react-router";
+
+const apiClientContext = unstable_createContext<APIClient>();
+
+function createBrowserRouter(routes, {
+  unstable_getContext() {
+    let context = new unstable_RouterContextProvider();
+    context.set(apiClientContext, getApiClient());
+    return context;
+  }
+})
+```
+
 ### opts.hydrationData
 
 When Server-Rendering and opting-out of automatic hydration, the
 `hydrationData` option allows you to pass in hydration data from your
 server-render. This will almost always be a subset of data from the
-[`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) value you get back from [`StaticHandler`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandler.html)'s
+[`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) value you get back from the [`StaticHandler`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandler.html)'s
 `query` method:
 
 ```tsx

docs/api/data-routers/createHashRouter.md

@@ -56,12 +56,29 @@ which is provided as the `context` argument to client [`action`](../../start/dat
 This function is called to generate a fresh `context` instance on each
 navigation or fetcher call.
 
+```tsx
+import {
+  unstable_createContext,
+  unstable_RouterContextProvider,
+} from "react-router";
+
+const apiClientContext = unstable_createContext<APIClient>();
+
+function createBrowserRouter(routes, {
+  unstable_getContext() {
+    let context = new unstable_RouterContextProvider();
+    context.set(apiClientContext, getApiClient());
+    return context;
+  }
+})
+```
+
 ### opts.hydrationData
 
 When Server-Rendering and opting-out of automatic hydration, the
 `hydrationData` option allows you to pass in hydration data from your
 server-render. This will almost always be a subset of data from the
-[`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) value you get back from [`StaticHandler`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandler.html)'s
+[`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) value you get back from the [`StaticHandler`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandler.html)'s
 `query` method:
 
 ```tsx

docs/api/hooks/useNavigate.md

@@ -135,3 +135,40 @@ For example, if you have a tab interface connected to search params in the
 middle of a page, and you don't want it to scroll to the top when a tab is
 clicked.
 
+### Return Type Augmentation
+
+Internally, `useNavigate` uses a separate implementation when you are in
+Declarative mode versus Data/Framework mode - the primary difference being
+that the latter is able to return a stable reference that does not change
+identity across navigations. The implementation in Data/Framework mode also
+returns a `Promise` that resolves when the navigation is completed. This means
+the return type of `useNavigate` is `void | Promise<void>`. This is accurate,
+but can lead to some red squigglies based on the union in the return value:
+
+- If you're using `typescript-eslint`, you may see errors from
+  [`@typescript-eslint/no-floating-promises`](https://typescript-eslint.io/rules/no-floating-promises/)
+- In Framework/Data mode, `React.use(navigate())` will show a false-positive
+  `Argument of type 'void | Promise<void>' is not assignable to parameter of
+  type 'Usable<void>'` error
+
+The easiest way to work around these issues is to augment the type based on the
+router you're using:
+
+```ts
+// If using <BrowserRouter>
+declare module "react-router" {
+  interface NavigateFunction {
+    (to: To, options?: NavigateOptions): void;
+    (delta: number): void;
+  }
+}
+
+// If using <RouterProvider> or Framework mode
+declare module "react-router" {
+  interface NavigateFunction {
+    (to: To, options?: NavigateOptions): Promise<void>;
+    (delta: number): Promise<void>;
+  }
+}
+```
+

docs/api/utils/RouterContextProvider.md

@@ -42,6 +42,7 @@ import {
 const userContext = unstable_createContext<User | null>(null);
 const contextProvider = new unstable_RouterContextProvider();
 contextProvider.set(userContext, getUser());
+//                               ^ Type-safe
 const user = contextProvider.get(userContext);
 //    ^ User
 ```

docs/api/utils/createContext.md

@@ -31,12 +31,10 @@ 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 [`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.
-
-<docs-warning>Enable this API with the `future.unstable_middleware` flag.</docs-warning>
+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