Add a generated API reference to the docs site

docs/.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .vitepress/cache/
 .vitepress/dist/
+api/

docs/.vitepress/config.ts

@@ -1,7 +1,13 @@
-import { defineConfig } from "vitepress";
+import { readFileSync } from "node:fs";
+import { type DefaultTheme, defineConfig } from "vitepress";
 import llmstxt from "vitepress-plugin-llms";
 import { withMermaid } from "vitepress-plugin-mermaid";
 
+// Generated by docs/typedoc before every docs build.
+const typedocSidebar: DefaultTheme.SidebarItem[] = JSON.parse(
+  readFileSync(new URL("../api/typedoc-sidebar.json", import.meta.url), "utf8"),
+);
+
 export default withMermaid(
   defineConfig({
     title: "Foundatio FetchClient",
@@ -38,9 +44,11 @@ export default withMermaid(
       siteTitle: "FetchClient",
       nav: [
         { text: "Guide", link: "/guide/what-is-fetchclient" },
+        { text: "API", link: "/api/" },
         { text: "GitHub", link: "https://github.com/FoundatioFx/FetchClient" },
       ],
       sidebar: {
+        "/api/": [{ text: "API Reference", link: "/api/", items: typedocSidebar }],
         "/guide/": [
           {
             text: "Introduction",

docs/guide/configuration.md

@@ -260,4 +260,6 @@ export async function deleteUser(id: number) {
 For advanced use cases like connecting to multiple APIs with different
 configurations, you can create separate `FetchClientProvider` instances. Each
 provider has its own options, middleware, and cache, and
-`provider.getFetchClient()` returns clients that use them.
+`provider.getFetchClient()` returns clients that use them. See the
+[`FetchClientProvider` API reference](/api/@foundatiofx/fetchclient/classes/FetchClientProvider)
+for details.

docs/guide/contributing.md

@@ -22,6 +22,9 @@ The docs site in `docs/` is part of the pnpm workspace:
 - Dev: `vp run docs:dev`
 - Build: `vp run docs:build`
 
+The [API reference](/api/) is generated from the JSDoc comments in `src/` by
+TypeDoc on every docs build, so document public APIs in the source.
+
 ## License
 
 MIT © Foundatio

docs/package.json

@@ -5,11 +5,13 @@
   "description": "FetchClient Documentation",
   "type": "module",
   "scripts": {
-    "dev": "vitepress dev",
-    "build": "vitepress build",
+    "api": "vp run @foundatiofx/fetchclient-typedoc#build",
+    "dev": "vp run api && vitepress dev",
+    "build": "vp run api && vitepress build",
     "preview": "vitepress preview"
   },
   "devDependencies": {
+    "@types/node": "^24.19.1",
     "mermaid": "^11.16.0",
     "vitepress": "^2.0.0-alpha.18",
     "vitepress-plugin-llms": "^1.13.4",

docs/typedoc/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@foundatiofx/fetchclient-typedoc",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Generates the FetchClient API reference for the docs site",
+  "type": "module",
+  "scripts": {
+    "build": "typedoc"
+  },
+  "devDependencies": {
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.13.1",
+    "typedoc-vitepress-theme": "^1.1.4",
+    "typescript": "~6.0.3"
+  }
+}

docs/typedoc/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["../../src"]
+}

docs/typedoc/typedoc.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "name": "API Reference",
+  "entryPoints": ["../../src/index.ts", "../../src/mocks/index.ts"],
+  "tsconfig": "./tsconfig.json",
+  "out": "../api",
+  "docsRoot": "..",
+  "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
+  "readme": "none",
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "disableGit": true,
+  "gitRevision": "main",
+  "sourceLinkTemplate": "https://github.com/FoundatioFx/FetchClient/blob/{gitRevision}/src/{path}#L{line}"
+}