chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/hooks/useAsyncError.md

@@ -4,13 +4,24 @@ title: useAsyncError
 
 # useAsyncError
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useAsyncError.html)
 
-Returns the rejection value from the closest [Await](../components/Await).
+Returns the rejection value from the closest [`<Await>`](../components/Await).
 
 ```tsx
 import { Await, useAsyncError } from "react-router";
@@ -34,3 +45,4 @@ function ErrorElement() {
 ```tsx
 useAsyncError(): unknown
 ```
+

docs/api/hooks/useAsyncValue.md

@@ -4,13 +4,24 @@ title: useAsyncValue
 
 # useAsyncValue
 
-[MODES: framework]
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
+[MODES: framework, data]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useAsyncValue.html)
 
-Returns the resolved promise value from the closest [Await](../components/Await).
+Returns the resolved promise value from the closest [`<Await>`](../components/Await).
 
 ```tsx
 function SomeDescendant() {
@@ -29,3 +40,4 @@ function SomeDescendant() {
 ```tsx
 useAsyncValue(): unknown
 ```
+

docs/api/hooks/useHref.md

@@ -4,6 +4,17 @@ title: useHref
 
 # useHref
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
@@ -24,19 +35,18 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-useHref(to, __namedParameters): string
+useHref(to: To, { relative }: {
+    relative?: RelativeRoutingType;
+} = {}): string
 ```
 
 ## Params
 
 ### to
 
-[modes: framework, data, declarative]
-
-_No documentation_
+The path to resolve
 
-### \_\_namedParameters
+### options.relative
 
-[modes: framework, data, declarative]
+Defaults to "route" so routing is relative to the route tree. Set to "path" to make relative routing operate against path segments.
 
-_No documentation_

docs/api/hooks/useInRouterContext.md

@@ -4,6 +4,17 @@ title: useInRouterContext
 
 # useInRouterContext
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data]
 
 ## Summary
@@ -18,3 +29,4 @@ a component is used within a Router.
 ```tsx
 useInRouterContext(): boolean
 ```
+

docs/api/hooks/useLocation.md

@@ -4,13 +4,24 @@ title: useLocation
 
 # useLocation
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useLocation.html)
 
-Returns the current [Location]([../Other/Location](https://api.reactrouter.com/v7/interfaces/react_router.Location.html)). This can be useful if you'd like to perform some side effect whenever it changes.
+Returns the current [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html). This can be useful if you'd like to perform some side effect whenever it changes.
 
 ```tsx
 import * as React from 'react'
@@ -35,3 +46,4 @@ function SomeComponent() {
 ```tsx
 useLocation(): Location
 ```
+

docs/api/hooks/useMatch.md

@@ -4,6 +4,17 @@ title: useMatch
 
 # useMatch
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
@@ -14,19 +25,15 @@ Returns a PathMatch object if the given pattern matches the current URL.
 This is useful for components that need to know "active" state, e.g.
 `<NavLink>`.
 
-
-
 ## Signature
 
 ```tsx
-useMatch(pattern): undefined
+useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamKey> | null
 ```
 
 ## Params
 
 ### pattern
 
-[modes: framework, data, declarative]
-
-_No documentation_
+The pattern to match against the current location
 

docs/api/hooks/useMatches.md

@@ -4,6 +4,17 @@ title: useMatches
 
 # useMatches
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data]
 
 ## Summary
@@ -16,5 +27,6 @@ parent/child routes or the route "handle" property
 ## Signature
 
 ```tsx
-useMatches(): undefined
+useMatches(): UIMatch[]
 ```
+

docs/api/hooks/useNavigate.md

@@ -4,57 +4,68 @@ title: useNavigate
 
 # useNavigate
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useNavigate.html)
 
-Returns a function that lets you navigate programmatically in the browser in response to user interactions or effects.
+Returns a function that lets you navigate programmatically in the browser in
+response to user interactions or effects.
+
+It's often better to use [`redirect`](../utils/redirect) in [`action`](../../start/framework/route-module#action)/[`loader`](../../start/framework/route-module#loader) functions than this hook.
+
+The returned function signature is `navigate(to, options?)/navigate(delta)` where:
+
+* `to` can be a string path, a `To` object, or a number (delta)
+* `options` contains options for modifying the navigation
+  * `flushSync`: Wrap the DOM updates in `ReactDom.flushSync`
+  * `preventScrollReset`: Do not scroll back to the top of the page after navigation
+  * `relative`: "route" or "path" to control relative routing logic
+  * `replace`: Replace the current entry in the history stack
+  * `state`: Optional history state to include with the new `Location`
+  * `viewTransition`: Enable `document.startViewTransition` for this navigation
 
 ```tsx
 import { useNavigate } from "react-router";
 
 function SomeComponent() {
   let navigate = useNavigate();
   return (
-    <button
-      onClick={() => {
-        navigate(-1);
-      }}
-    />
+    <button onClick={() => navigate(-1)}>
+      Go Back
+    </button>
   );
 }
 ```
 
-It's often better to use [redirect](../utils/redirect) in [ActionFunction](https://api.reactrouter.com/v7/interfaces/react_router.ActionFunction.html) and [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) than this hook.
-
 ## Signature
 
 ```tsx
-navigate(
-  to: To,
-  options?: {
-    flushSync?: boolean;
-    preventScrollReset?: boolean;
-    relative?: RelativeRoutingType;
-    replace?: boolean;
-    state?: any;
-    viewTransition?: boolean;
-  }
-): void | Promise<void>;
+useNavigate(): NavigateFunction
 ```
 
 ## Examples
 
-### Navigate to another path:
+### Navigate to another path
 
 ```tsx
 navigate("/some/route");
 navigate("/some/route?search=param");
 ```
 
-### Navigate with a `To` object:
+### Navigate with a `To` object
 
 All properties are optional.
 
@@ -69,7 +80,7 @@ navigate({
 
 If you use `state`, that will be available on the `location` object on the next page. Access it with `useLocation().state` (see [useLocation](./useLocation)).
 
-### Navigate back or forward in the history stack:
+### Navigate back or forward in the history stack
 
 ```tsx
 // back
@@ -85,7 +96,7 @@ Be cautions with `navigate(number)`. If your application can load up to a route
 
 Only use this if you're sure they will have an entry in the history stack to navigate to.
 
-### Replace the current entry in the history stack:
+### Replace the current entry in the history stack
 
 This will remove the current entry in the history stack, replacing it with a new one, similar to a server side redirect.
 
@@ -95,7 +106,10 @@ navigate("/some/route", { replace: true });
 
 ### Prevent Scroll Reset
 
-[modes: framework, data]
+[MODES: framework, data]
+
+<br/>
+<br/>
 
 To prevent `<ScrollRestoration>` from resetting the scroll position, use the `preventScrollReset` option.
 
@@ -104,3 +118,4 @@ navigate("?some-tab=1", { preventScrollReset: true });
 ```
 
 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.
+

docs/api/hooks/useNavigation.md

@@ -4,6 +4,17 @@ title: useNavigation
 
 # useNavigation
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data]
 
 ## Summary
@@ -28,3 +39,4 @@ function SomeComponent() {
 ```tsx
 useNavigation(): Navigation
 ```
+