Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

feat(docs): includes integration entries in command+k search menu (#1005)

Colton Padden1d3dc91c3d05
diff --git a/apps/docs/app/api/search/route.ts b/apps/docs/app/api/search/route.ts
index be1b15d0b..1fa616d0e 100644
--- a/apps/docs/app/api/search/route.ts
+++ b/apps/docs/app/api/search/route.ts
@@ -1,5 +1,9 @@
import { createSearchRoute } from "@vercel/geistdocs/routes/search";
import { config } from "@/lib/geistdocs/config";
import { geistdocsSource } from "@/lib/geistdocs/source";
+import { integrationSource } from "@/lib/integrations/source";
-export const GET = createSearchRoute({ config, sources: [geistdocsSource] });
+export const GET = createSearchRoute({
+ config,
+ sources: [geistdocsSource, integrationSource],
+});
diff --git a/apps/docs/lib/integrations/discovery.test.ts b/apps/docs/lib/integrations/discovery.test.ts
new file mode 100644
index 000000000..80ea44755
--- /dev/null
+++ b/apps/docs/lib/integrations/discovery.test.ts
@@ -0,0 +1,14 @@
+import { describe, expect, it } from "vitest";
+import { getIntegration } from "./data";
+import { integrationSearchText } from "./discovery";
+
+describe("integration discovery", () => {
+ it("includes presentation keywords in searchable text", () => {
+ const slack = getIntegration("slack");
+ expect(slack).toBeDefined();
+
+ expect(integrationSearchText(slack!)).toContain("Slack");
+ expect(integrationSearchText(slack!)).toContain("Channel");
+ expect(integrationSearchText(slack!)).toContain("messaging");
+ });
+});
diff --git a/apps/docs/lib/integrations/discovery.ts b/apps/docs/lib/integrations/discovery.ts
new file mode 100644
index 000000000..3ffec33e4
--- /dev/null
+++ b/apps/docs/lib/integrations/discovery.ts
@@ -0,0 +1,16 @@
+import type { Integration } from "./data";
+
+const typeLabel: Record<Integration["type"], string> = {
+ channel: "Channel",
+ connection: "Connection",
+ extension: "Extension",
+};
+
+/** Plain text used by the advanced search index for one integration. */
+export const integrationSearchText = (integration: Integration): string =>
+ [
+ integration.name,
+ typeLabel[integration.type],
+ integration.tagline,
+ ...(integration.keywords ?? []),
+ ].join("\n");
diff --git a/apps/docs/lib/integrations/source.ts b/apps/docs/lib/integrations/source.ts
new file mode 100644
index 000000000..c4a2f9a26
--- /dev/null
+++ b/apps/docs/lib/integrations/source.ts
@@ -0,0 +1,61 @@
+import { createSource, type FumadocsCollection } from "@vercel/geistdocs/source";
+import { config } from "@/lib/geistdocs/config";
+import { integrationSearchText } from "./discovery";
+import { integrations } from "./data";
+
+const structuredData = (content: string) => ({
+ headings: [],
+ contents: [{ heading: undefined, content }],
+});
+
+const integrationFiles = [
+ {
+ type: "meta" as const,
+ path: "meta.json",
+ data: {
+ title: "Integrations",
+ root: true,
+ },
+ },
+ {
+ type: "page" as const,
+ path: "index.md",
+ slugs: [],
+ data: {
+ title: "Integrations",
+ description:
+ "Browse every third-party service eve connects to, including channels and connections.",
+ excludeFrom: ["search" as const],
+ type: "directory",
+ structuredData: structuredData("Integrations for eve."),
+ getText: async () => "Integrations for eve.",
+ },
+ },
+ ...integrations.map((integration) => {
+ return {
+ type: "page" as const,
+ path: `${integration.slug}.md`,
+ slugs: [integration.slug],
+ data: {
+ title: integration.name,
+ description: integration.tagline,
+ type: integration.type,
+ keywords: integration.keywords,
+ structuredData: structuredData(integrationSearchText(integration)),
+ getText: async () => integration.tagline,
+ },
+ };
+ }),
+];
+
+const integrationDocs: FumadocsCollection = {
+ toFumadocsSource: () => ({ files: integrationFiles }),
+};
+
+export const integrationSource = createSource({
+ baseUrl: "/integrations",
+ config,
+ docs: integrationDocs,
+ id: "integrations",
+ label: "Integrations",
+});