chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/components/Await.md

@@ -4,6 +4,18 @@ title: Await
 
 # Await
 
+<!--
+⚠️ ⚠️ 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/components.tsx#L1264
+-->
+
 [MODES: framework, data]
 
 ## Summary
@@ -12,16 +24,16 @@ title: Await
 
 Used to render promise values with automatic error handling.
 
+**Note:** `<Await>` expects to be rendered inside of a `<React.Suspense>`
+
 ```tsx
 import { Await, useLoaderData } from "react-router";
 
 export function loader() {
   // not awaited
   const reviews = getReviews();
   // awaited (blocks the transition)
-  const book = await fetch("/api/book").then((res) =>
-    res.json()
-  );
+  const book = await fetch("/api/book").then((res) => res.json());
   return { book, reviews };
 }
 
@@ -47,14 +59,16 @@ function Book() {
 }
 ```
 
-`<Await>` expects to be rendered inside of a `<React.Suspense>`
+## Signature
+
+```tsx
+function Await<Resolve>({ children, errorElement, resolve, }: AwaitProps<Resolve>)
+```
 
 ## Props
 
 ### children
 
-[modes: framework, data]
-
 When using a function, the resolved value is provided as the parameter.
 
 ```tsx [2]
@@ -63,13 +77,13 @@ When using a function, the resolved value is provided as the parameter.
 </Await>
 ```
 
-When using React elements, [useAsyncValue](../hooks/useAsyncValue) will provide the
+When using React elements, [`useAsyncValue`](../hooks/useAsyncValue) will provide the
 resolved value:
 
 ```tsx [2]
 <Await resolve={reviewsPromise}>
   <Reviews />
-</Await>;
+</Await>
 
 function Reviews() {
   const resolvedReviews = useAsyncValue();
@@ -79,8 +93,6 @@ function Reviews() {
 
 ### errorElement
 
-[modes: framework, data]
-
 The error element renders instead of the children when the promise rejects.
 
 ```tsx
@@ -92,7 +104,7 @@ The error element renders instead of the children when the promise rejects.
 </Await>
 ```
 
-To provide a more contextual error, you can use the [useAsyncError](../hooks/useAsyncError) in a
+To provide a more contextual error, you can use the [`useAsyncError`](../hooks/useAsyncError) in a
 child component
 
 ```tsx
@@ -101,7 +113,7 @@ child component
   resolve={reviewsPromise}
 >
   <Reviews />
-</Await>;
+</Await>
 
 function ReviewsError() {
   const error = useAsyncError();
@@ -110,14 +122,12 @@ function ReviewsError() {
 ```
 
 If you do not provide an errorElement, the rejected value will bubble up to
-the nearest route-level ErrorBoundary and be accessible
-via [useRouteError](../hooks/useRouteError) hook.
+the nearest route-level `ErrorBoundary` and be accessible via the
+[`useRouteError`](../hooks/useRouteError) hook.
 
 ### resolve
 
-[modes: framework, data]
-
-Takes a promise returned from a [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) value to be resolved and rendered.
+Takes a promise returned from a `loader` to be resolved and rendered.
 
 ```jsx
 import { useLoaderData, Await } from "react-router";
@@ -153,3 +163,4 @@ export default function Book() {
   );
 }
 ```
+

docs/api/components/Navigate.md

@@ -4,44 +4,55 @@ title: Navigate
 
 # Navigate
 
+<!--
+⚠️ ⚠️ 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/components.tsx#L645
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Navigate.html)
 
-A component-based version of [useNavigate](../hooks/useNavigate) to use in a [`React.Component
+A component-based version of [`useNavigate`](../hooks/useNavigate) to use in a [`React.Component
 Class`](https://reactjs.org/docs/react-component.html) where hooks are not
 able to be used.
 
-It's recommended to avoid using this component in favor of [useNavigate](../hooks/useNavigate)
+It's recommended to avoid using this component in favor of [`useNavigate`](../hooks/useNavigate)
 
 ```tsx
 <Navigate to="/tasks" />
 ```
 
-## Props
+## Signature
 
-### relative
+```tsx
+function Navigate({ to, replace, state, relative, }: NavigateProps): null
+```
 
-[modes: framework, data, declarative]
+## Props
+
+### to
 
-_No documentation_
+The path to navigate to. This can be a string or an object
 
 ### replace
 
-[modes: framework, data, declarative]
-
-_No documentation_
+Whether to replace the current entry in the history stack
 
 ### state
 
-[modes: framework, data, declarative]
+State to pass to the new location to store in [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state).
 
-_No documentation_
-
-### to
+### relative
 
-[modes: framework, data, declarative]
+How to interpret relative routing in the `to` prop. See [`RelativeRoutingType`](https://api.reactrouter.com/v7/types/react_router.RelativeRoutingType.html).
 
-_No documentation_

docs/api/components/Outlet.md

@@ -4,6 +4,18 @@ title: Outlet
 
 # Outlet
 
+<!--
+⚠️ ⚠️ 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/components.tsx#L724
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
@@ -25,16 +37,21 @@ export default function SomeParent() {
 }
 ```
 
+## Signature
+
+```tsx
+function Outlet(props: OutletProps): React.ReactElement | null
+```
+
 ## Props
 
 ### context
 
-[modes: framework, data, declarative]
-
 Provides a context value to the element tree below the outlet. Use when the parent route needs to provide values to child routes.
 
 ```tsx
 <Outlet context={myContextValue} />
 ```
 
-Access the context with [useOutletContext](../hooks/useOutletContext).
+Access the context with [`useOutletContext`](../hooks/useOutletContext).
+

docs/api/components/Route.md

@@ -4,45 +4,139 @@ title: Route
 
 # Route
 
+<!--
+⚠️ ⚠️ 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/components.tsx#L920
+-->
+
 [MODES: framework, data, declarative]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Route.html)
 
 Configures an element to render when a pattern matches the current location.
-It must be rendered within a [Routes](../components/Routes) element. Note that these routes
+It must be rendered within a [`Routes`](../components/Routes) element. Note that these routes
 do not participate in data loading, actions, code splitting, or any other
 route module features.
 
+```tsx
+// Usually used in a declarative router
+function App() {
+  return (
+    <BrowserRouter>
+      <Routes>
+        <Route index element={<StepOne />} />
+        <Route path="step-2" element={<StepTwo />} />
+        <Route path="step-3" element={<StepThree />} />
+      </Routes>
+   </BrowserRouter>
+  );
+}
+
+// But can be used with a data router as well if you prefer the JSX notation
+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} />
+  </>
+);
+
+const router = createBrowserRouter(routes);
+
+function App() {
+  return <RouterProvider router={router} />;
+}
+```
+
+## Signature
+
+```tsx
+function Route(props: RouteProps): React.ReactElement | null
+```
+
 ## Props
 
 ### caseSensitive
 
-[modes: framework, data, declarative]
+Whether the path should be case sensitive. Defaults to `false`.
 
-Whether the path should be matched in a case-sensitive manner.
+### path
 
-### children
+The path pattern to match. If unspecified or empty then this becomes a layout route.
 
-[modes: framework, data, declarative]
+### id
 
-_No documentation_
+The unique identifier for this route (for use with Data routers)
 
-### Component
+### lazy
+
+A function that returns a promise that resolves to the route object.
+Used for code-splitting routes.
+See [`lazy`](../../../start/data/route-object#lazy).
+
+### loader
+
+The route loader.
+See [`loader`](../../../start/data/route-object#loader).
+
+### action
+
+The route action.
+See [`action`](../../../start/data/route-object#action).
+
+### shouldRevalidate
+
+The route shouldRevalidate function.
+See [`shouldRevalidate`](../../../start/data/route-object#shouldRevalidate).
 
-[modes: framework, data, declarative]
+### handle
 
-_No documentation_
+The route handle.
+
+### index
+
+Whether or not this is an index route.
+
+### children
+
+Child Route components
 
 ### element
 
-[modes: framework, data, declarative]
+The React element to render when this Route matches.
+Mutually exclusive with `Component`.
 
-_No documentation_
+### hydrateFallbackElement
 
-### path
+The React element to render while this router is loading data.
+Mutually exclusive with `HydrateFallback`.
+
+### errorElement
+
+The React element to render at this route if an error occurs.
+Mutually exclusive with `ErrorBoundary`.
+
+### Component
+
+The React Component to render when this route matches.
+Mutually exclusive with `element`.
+
+### HydrateFallback
+
+The React Component to render while this router is loading data.
+Mutually exclusive with `hydrateFallbackElement`.
+
+### ErrorBoundary
 
-[modes: framework, data, declarative]
+The React Component to render at this route if an error occurs.
+Mutually exclusive with `errorElement`.
 
-The path to match against the current location.