docs: basic api ref generator (#1337)

.gitignore

@@ -37,5 +37,6 @@ last_recording.mp4
 
 # auto-generated
 /js/core/src/__codegen
+/js/api-refs-js
 
 !samples/chatbot/server/genkit-ai-vertexai-*.tgz

js/genkit/typedoc.json

@@ -0,0 +1,20 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+    "src/registry.ts",
+    "src/tracing.ts",
+    "src/logging.ts",
+    "src/schema.ts",
+    "src/retriever.ts",
+    "src/reranker.ts",
+    "src/embedder.ts",
+    "src/evaluator.ts",
+    "src/model.ts",
+    "src/middleware.ts",
+    "src/extract.ts",
+    "src/testing.ts",
+    "src/tool.ts",
+    "src/plugin.ts",
+    "src/client/index.ts"
+  ]
+}

js/package.json

@@ -15,12 +15,19 @@
     "pack:ai": "cd ai && pnpm pack --pack-destination ../../dist",
     "pack:genkit": "cd genkit && pnpm pack --pack-destination ../../dist",
     "pack:plugins": "for i in plugins/*/; do cd $i && pnpm pack --pack-destination ../../../dist && cd ../..; done",
-    "test:all": "pnpm -r --workspace-concurrency 0 -F \"./(ai|core|plugins|genkit)/**\" test"
+    "test:all": "pnpm -r --workspace-concurrency 0 -F \"./(ai|core|plugins|genkit)/**\" test",
+    "gendocs": "pnpm build && pnpm typedoc",
+    "typedoc-html": "typedoc --options typedoc.json"
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5",
     "only-allow": "^1.2.1",
-    "typescript": "^4.9.0"
+    "typescript": "^4.9.0",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-markdown": "^4.2.10",
+    "typedoc-plugin-zod": "^1.2.1",
+    "typedoc-material-theme": "^1.1.0",
+    "tsx": "^4.19.2"
   },
   "packageManager": "pnpm@9.13.2+sha256.ccce81bf7498c5f0f80e31749c1f8f03baba99d168f64590fc7e13fad3ea1938"
 }

js/plugins/checks/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/chroma/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/dev-local-vectorstore/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/dotprompt/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/evaluators/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/firebase/typedoc.json

@@ -0,0 +1,8 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+    "src/functions.ts",
+    "src/auth.ts",
+    "src/user_egagement.ts"
+  ]
+}

js/plugins/google-cloud/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/googleai/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/langchain/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/ollama/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/pinecone/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

js/plugins/vertexai/typedoc.json

@@ -0,0 +1,9 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+    "src/modelgarden/index.ts",
+    "src/evaluation/index.ts",
+    "src/rerankers/index.ts",
+    "src/vectorsearch/index.ts"
+  ]
+}