nav tweaks

firebase · Dec 16, 2024 · ddafc9e · ddafc9e
1 parent 98022e5
commit ddafc9e
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 6 deletions.
diff --git a/js/genkit/src/index.ts b/js/genkit/src/index.ts
@@ -1,4 +1,6 @@
 /**
+ * @license
+ *
  * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,6 +16,15 @@
  * limitations under the License.
  */
 
+/**
+ * Main genkit import.
+ * 
+ * ```ts
+ * import { genkit } from 'genkit';
+ * ```
+ * 
+ * @module /
+ */
 export {
   BaseDataPointSchema,
   Document,
@@ -134,4 +145,9 @@ export {
   type __RequestWithAuth,
 } from '@genkit-ai/core';
 export { loadPromptFile } from '@genkit-ai/dotprompt';
-export { Genkit, GenkitOptions, PromptMetadata, genkit } from './genkit.js';
+export {
+  Genkit,
+  genkit,
+  type GenkitOptions,
+  type PromptMetadata,
+} from './genkit.js';
diff --git a/js/package.json b/js/package.json
@@ -18,7 +18,7 @@
     "test:all": "pnpm -r --workspace-concurrency 0 -F \"./(ai|core|plugins|genkit)/**\" test && pnpm test:esm",
     "test:esm": "cd testapps/esm && pnpm test",
     "gendocs": "pnpm build && pnpm typedoc",
-    "typedoc-html": "typedoc --options typedoc.json"
+    "typedoc-html": "typedoc --sortEntryPoints false --options typedoc.json"
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5",

diff --git a/js/plugins/firebase/src/index.ts b/js/plugins/firebase/src/index.ts
@@ -1,4 +1,6 @@
 /**
+ * @license
+ *
  * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,6 +16,10 @@
  * limitations under the License.
  */
 
+/**
+ * @module /
+ */
+
 import {
   enableGoogleCloudTelemetry,
   GcpTelemetryConfigOptions,

diff --git a/js/plugins/vertexai/src/index.ts b/js/plugins/vertexai/src/index.ts
@@ -1,4 +1,6 @@
 /**
+ * @license
+ *
  * Copyright 2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,6 +16,10 @@
  * limitations under the License.
  */
 
+/**
+ * @module /
+ */
+
 import { Genkit } from 'genkit';
 import { GenkitPlugin, genkitPlugin } from 'genkit/plugin';
 import { getDerivedParams } from './common/index.js';

diff --git a/js/typedoc.json b/js/typedoc.json
@@ -1,17 +1,17 @@
 {
   "entryPoints": [
     "genkit",
-    "plugins/vertexai",
     "plugins/googleai",
+    "plugins/vertexai",
     "plugins/firebase",
     "plugins/google-cloud",
     "plugins/checks",
-    "plugins/chroma",
     "plugins/dev-local-vectorstore",
     "plugins/evaluators",
     "plugins/express",
-    "plugins/mcp",
     "plugins/ollama",
+    "plugins/chroma",
+    "plugins/mcp",
     "plugins/pinecone"
   ],
   "name": "Genkit JS API reference",
@@ -21,5 +21,13 @@
   "sort": ["kind", "instance-first", "alphabetical"],
   "sortEntryPoints": true,
   "readme": "index.typedoc.md",
-  "plugin": ["typedoc-plugin-zod"]
+  "plugin": ["typedoc-plugin-zod"],
+  "navigation": {
+    "includeCategories": false,
+    "includeGroups": false,
+    "includeFolders": false,
+    "compactFolders": false,
+    "excludeReferences": true
+  },
+  "categorizeByGroup": false
 }