Auto-generate docs for DOM-related APIs (#14002)

Author: brophdawg11

.eslintrc

@@ -21,7 +21,10 @@
     },
     {
       // Only apply JSDoc lint rules to files we auto-generate docs for
-      "files": ["packages/react-router/lib/hooks.tsx"],
+      "files": [
+        "packages/react-router/lib/hooks.tsx",
+        "packages/react-router/lib/dom/lib.tsx"
+      ],
       "plugins": ["jsdoc"],
       "rules": {
         "jsdoc/check-access": "error",
@@ -58,6 +61,7 @@
               },
               {
                 "tags": [
+                  "name",
                   "public",
                   "private",
                   "category",

.github/workflows/docs.yml

@@ -11,10 +11,6 @@ on:
       branch:
         description: "Branch to generate docs for (usually dev)"
         required: true
-      api:
-        description: "API Names to generate docs for"
-        required: false
-        default: ""
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -50,13 +46,10 @@ jobs:
       - name: 📚 Generate Typedoc Docs
         run: pnpm run docs
 
-      - name: 📚 Generate Markdown Docs (for all APIs)
-        if: github.event.inputs.api == ''
-        run: node --experimental-strip-types scripts/docs.ts --path packages/react-router/lib/hooks.tsx --write
-
-      - name: 📚 Generate Markdown Docs (for specific APIs)
-        if: github.event.inputs.api != ''
-        run: node --experimental-strip-types scripts/docs.ts --path packages/react-router/lib/hooks.tsx --write --api ${{ github.event.inputs.api }}
+      - name: 📚 Generate Markdown Docs
+        run: |
+          node --experimental-strip-types scripts/docs.ts --path packages/react-router/lib/hooks.tsx --write
+          node --experimental-strip-types scripts/docs.ts --path packages/react-router/lib/dom/lib.tsx --write
 
       - name: 💪 Commit
         run: |

docs/api/declarative-routers/unstable_HistoryRouter.md

@@ -204,7 +204,11 @@ export {
   Scripts,
   PrefetchPageLinks,
 } from "./lib/dom/ssr/components";
-export type { ScriptsProps } from "./lib/dom/ssr/components";
+export type {
+  ScriptsProps,
+  PrefetchBehavior,
+  DiscoverBehavior,
+} from "./lib/dom/ssr/components";
 export type { EntryContext } from "./lib/dom/ssr/entry";
 export type {
   ClientActionFunction,