Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

Use sidebar labels for overview titles (#925)

John Phamous4d54633fb59d
diff --git a/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx b/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx
index c2d1591d3..111195903 100644
--- a/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx
+++ b/apps/docs/app/[lang]/docs/[[...slug]]/page.tsx
@@ -5,6 +5,7 @@ import { EditOnGithubAction } from "@/components/geistdocs/edit-on-github";
import { getMDXComponents } from "@/components/geistdocs/mdx-components";
import { config } from "@/lib/geistdocs/config";
import { staticOgImage } from "@/lib/geistdocs/og";
+import { resolveDocsPageTitle } from "@/lib/geistdocs/page-title";
import { geistdocsSource } from "@/lib/geistdocs/source";
import { getSiteOrigin } from "@/lib/geistdocs/url";
@@ -19,17 +20,24 @@ const docsPage = createDocsPage({
const components: MDXComponents = link ? { a: link } : {};
return getMDXComponents(components);
},
- metadata: ({ metadata }) => ({
- ...metadata,
- metadataBase: new URL(getSiteOrigin()),
- openGraph: {
- ...metadata.openGraph,
- // Override with the static OG image for now. To restore dynamic per-page
- // OG generation, add `page` back to the destructure above and swap the
- // line below back to: images: geistdocsSource.getPageImage(page).url,
- images: [staticOgImage],
- },
- }),
+ metadata: ({ metadata, page, params }) => {
+ return {
+ ...metadata,
+ title: resolveDocsPageTitle({
+ pageTitle: page.data.title,
+ pageUrl: page.url,
+ tree: geistdocsSource.source.getPageTree(params.lang),
+ }),
+ metadataBase: new URL(getSiteOrigin()),
+ openGraph: {
+ ...metadata.openGraph,
+ // Override with the static OG image for now. To restore dynamic per-page
+ // OG generation, swap the line below back to:
+ // images: geistdocsSource.getPageImage(page).url,
+ images: [staticOgImage],
+ },
+ };
+ },
source: geistdocsSource,
tableOfContentPopover: {
enabled: false,
diff --git a/apps/docs/lib/geistdocs/page-title.test.ts b/apps/docs/lib/geistdocs/page-title.test.ts
new file mode 100644
index 000000000..86fd6f30a
--- /dev/null
+++ b/apps/docs/lib/geistdocs/page-title.test.ts
@@ -0,0 +1,93 @@
+import { describe, expect, it } from "vitest";
+import { resolveDocsPageTitle } from "./page-title";
+
+describe("resolveDocsPageTitle", () => {
+ it("uses the sidebar parent title for an Overview page", () => {
+ const tree = {
+ name: "Docs",
+ children: [
+ {
+ type: "folder",
+ name: "Channels",
+ children: [{ type: "page", name: "Overview", url: "/docs/channels/overview" }],
+ },
+ ],
+ };
+
+ expect(
+ resolveDocsPageTitle({
+ pageTitle: "Overview",
+ pageUrl: "/docs/channels/overview",
+ tree,
+ }),
+ ).toBe("Channels");
+ });
+
+ it("preserves the title of a non-Overview page", () => {
+ const tree = {
+ name: "Docs",
+ children: [
+ {
+ type: "folder",
+ name: "Channels",
+ children: [{ type: "page", name: "Microsoft Teams", url: "/docs/channels/teams" }],
+ },
+ ],
+ };
+
+ expect(
+ resolveDocsPageTitle({
+ pageTitle: "Microsoft Teams",
+ pageUrl: "/docs/channels/teams",
+ tree,
+ }),
+ ).toBe("Microsoft Teams");
+ });
+
+ it("uses the folder title for an Overview index page", () => {
+ const tree = {
+ name: "Docs",
+ children: [
+ {
+ type: "folder",
+ name: "Connections",
+ index: { type: "page", name: "Overview", url: "/docs/connections" },
+ children: [],
+ },
+ ],
+ };
+
+ expect(
+ resolveDocsPageTitle({
+ pageTitle: "Overview",
+ pageUrl: "/docs/connections",
+ tree,
+ }),
+ ).toBe("Connections");
+ });
+
+ it("resolves an Overview page from the fallback tree", () => {
+ const tree = {
+ name: "Docs",
+ children: [],
+ fallback: {
+ name: "Docs",
+ children: [
+ {
+ type: "folder",
+ name: "Evals",
+ children: [{ type: "page", name: "Overview", url: "/docs/evals/overview" }],
+ },
+ ],
+ },
+ };
+
+ expect(
+ resolveDocsPageTitle({
+ pageTitle: "Overview",
+ pageUrl: "/docs/evals/overview",
+ tree,
+ }),
+ ).toBe("Evals");
+ });
+});
diff --git a/apps/docs/lib/geistdocs/page-title.ts b/apps/docs/lib/geistdocs/page-title.ts
new file mode 100644
index 000000000..91c288f63
--- /dev/null
+++ b/apps/docs/lib/geistdocs/page-title.ts
@@ -0,0 +1,44 @@
+// Geistdocs owns the page-tree version, which can differ from the docs app's Fumadocs version.
+interface SidebarNode {
+ children?: SidebarNode[];
+ fallback?: SidebarNode;
+ index?: SidebarNode;
+ name?: unknown;
+ type?: string;
+ url?: string;
+}
+
+interface ResolveDocsPageTitleOptions {
+ pageTitle?: string;
+ pageUrl: string;
+ tree: SidebarNode;
+}
+
+const findSidebarParentTitle = (node: SidebarNode, url: string): string | undefined => {
+ if (node.index?.type === "page" && node.index.url === url) {
+ return typeof node.name === "string" ? node.name : undefined;
+ }
+
+ if (node.fallback) {
+ const title = findSidebarParentTitle(node.fallback, url);
+ if (title !== undefined) return title;
+ }
+
+ for (const child of node.children ?? []) {
+ if (child.type === "page" && child.url === url) {
+ return typeof node.name === "string" ? node.name : undefined;
+ }
+
+ const title = findSidebarParentTitle(child, url);
+ if (title !== undefined) return title;
+ }
+};
+
+export const resolveDocsPageTitle = ({
+ pageTitle,
+ pageUrl,
+ tree,
+}: ResolveDocsPageTitleOptions): string | undefined => {
+ if (pageTitle !== "Overview") return pageTitle;
+ return findSidebarParentTitle(tree, pageUrl) ?? pageTitle;
+};
diff --git a/apps/docs/package.json b/apps/docs/package.json
index 545d7d569..ee99c4779 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -10,6 +10,7 @@
"start": "next start",
"postinstall": "fumadocs-mdx",
"translate": "npx @vercel/geistdocs translate",
+ "test:unit": "vitest run --config vitest.config.ts",
"render:eve-5": "NODE_OPTIONS=--loader=./scripts/wgsl-node-loader.mjs tsx scripts/render-eve-5.ts"
},
"dependencies": {
@@ -71,6 +72,7 @@
"tailwindcss": "4.3.0",
"tsx": "^4.21.0",
"tw-animate-css": "1.4.0",
- "typescript": "6.0.3"
+ "typescript": "6.0.3",
+ "vitest": "catalog:"
}
}
diff --git a/apps/docs/vitest.config.ts b/apps/docs/vitest.config.ts
new file mode 100644
index 000000000..cc7a8facb
--- /dev/null
+++ b/apps/docs/vitest.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+ test: {
+ include: ["lib/**/*.test.ts"],
+ },
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index bfccd5eea..e673ce2e5 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -294,6 +294,9 @@ importers:
typescript:
specifier: 6.0.3
version: 6.0.3
+ vitest:
+ specifier: 'catalog:'
apps/fixtures/agent-tui-client:
dependencies: