Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

feat(docs): add eve changelog (#3153)

Rich Hainesa46edbd7bbf1
diff --git a/apps/docs/app/[lang]/changelog-pages.mdx/[page]/route.ts b/apps/docs/app/[lang]/changelog-pages.mdx/[page]/route.ts
new file mode 100644
index 000000000..deb5ff9fd
--- /dev/null
+++ b/apps/docs/app/[lang]/changelog-pages.mdx/[page]/route.ts
@@ -0,0 +1,7 @@
+import { createChangelogMarkdownRoute } from "@vercel/geistdocs/routes/changelog";
+import { changelogOptions } from "@/lib/geistdocs/changelog";
+
+const changelogRoute = createChangelogMarkdownRoute(changelogOptions);
+
+export const GET = changelogRoute.GET;
+export const generateStaticParams = changelogRoute.generatePageParams;
diff --git a/apps/docs/app/[lang]/changelog.md/route.ts b/apps/docs/app/[lang]/changelog.md/route.ts
new file mode 100644
index 000000000..ca77fb0f6
--- /dev/null
+++ b/apps/docs/app/[lang]/changelog.md/route.ts
@@ -0,0 +1,7 @@
+import { createChangelogMarkdownRoute } from "@vercel/geistdocs/routes/changelog";
+import { changelogOptions } from "@/lib/geistdocs/changelog";
+
+const changelogRoute = createChangelogMarkdownRoute(changelogOptions);
+
+export const GET = changelogRoute.GET;
+export const generateStaticParams = changelogRoute.generateStaticParams;
diff --git a/apps/docs/app/[lang]/changelog/data/[page]/route.ts b/apps/docs/app/[lang]/changelog/data/[page]/route.ts
new file mode 100644
index 000000000..d57144d17
--- /dev/null
+++ b/apps/docs/app/[lang]/changelog/data/[page]/route.ts
@@ -0,0 +1,7 @@
+import { createChangelogDataRoute } from "@vercel/geistdocs/routes/changelog";
+import { changelogOptions } from "@/lib/geistdocs/changelog";
+
+const changelogRoute = createChangelogDataRoute(changelogOptions);
+
+export const GET = changelogRoute.GET;
+export const generateStaticParams = changelogRoute.generateStaticParams;
diff --git a/apps/docs/app/[lang]/changelog/page.tsx b/apps/docs/app/[lang]/changelog/page.tsx
new file mode 100644
index 000000000..831bbecbc
--- /dev/null
+++ b/apps/docs/app/[lang]/changelog/page.tsx
@@ -0,0 +1,12 @@
+import { createChangelogPage } from "@vercel/geistdocs/pages/changelog";
+import { changelogOptions } from "@/lib/geistdocs/changelog";
+import { getRootLang } from "@/lib/geistdocs/root-params";
+
+const changelogPage = createChangelogPage({
+ ...changelogOptions,
+ getLang: getRootLang,
+});
+
+export const generateMetadata = changelogPage.generateMetadata;
+export const generateStaticParams = changelogPage.generateStaticParams;
+export default changelogPage.Page;
diff --git a/apps/docs/app/[lang]/changelog/page/[page]/page.tsx b/apps/docs/app/[lang]/changelog/page/[page]/page.tsx
new file mode 100644
index 000000000..bdd1e5931
--- /dev/null
+++ b/apps/docs/app/[lang]/changelog/page/[page]/page.tsx
@@ -0,0 +1,12 @@
+import { createChangelogPage } from "@vercel/geistdocs/pages/changelog";
+import { changelogOptions } from "@/lib/geistdocs/changelog";
+import { getRootLang } from "@/lib/geistdocs/root-params";
+
+const changelogPage = createChangelogPage({
+ ...changelogOptions,
+ getLang: getRootLang,
+});
+
+export const generateMetadata = changelogPage.generatePaginatedMetadata;
+export const generateStaticParams = changelogPage.generatePageParams;
+export default changelogPage.PaginatedPage;
diff --git a/apps/docs/geistdocs.tsx b/apps/docs/geistdocs.tsx
index 9c06417a1..972d150b6 100644
--- a/apps/docs/geistdocs.tsx
+++ b/apps/docs/geistdocs.tsx
@@ -23,6 +23,10 @@ export const nav = [
label: "Templates",
href: "/templates",
},
+ {
+ label: "Changelog",
+ href: "/changelog",
+ },
];
export const suggestions = [
@@ -33,6 +37,13 @@ export const suggestions = [
];
export const agent = {
+ links: [
+ {
+ label: "Changelog",
+ href: "/changelog.md",
+ description: "eve release notes as Markdown, with links to older releases.",
+ },
+ ],
product: {
name: "eve",
description:
diff --git a/apps/docs/lib/geistdocs/changelog-source.ts b/apps/docs/lib/geistdocs/changelog-source.ts
new file mode 100644
index 000000000..35d16e4e1
--- /dev/null
+++ b/apps/docs/lib/geistdocs/changelog-source.ts
@@ -0,0 +1,11 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { createChangesetsChangelogSource } from "@vercel/geistdocs/changelog";
+
+const readChangelog = async () => {
+ "use cache";
+
+ return readFile(path.join(process.cwd(), "../../packages/eve/CHANGELOG.md"), "utf8");
+};
+
+export const changelogSource = createChangesetsChangelogSource({ read: readChangelog });
diff --git a/apps/docs/lib/geistdocs/changelog.test.ts b/apps/docs/lib/geistdocs/changelog.test.ts
new file mode 100644
index 000000000..0938a9762
--- /dev/null
+++ b/apps/docs/lib/geistdocs/changelog.test.ts
@@ -0,0 +1,19 @@
+import { describe, expect, it } from "vitest";
+import { changelogSource } from "./changelog-source";
+
+describe("changelog source", () => {
+ it("publishes the eve release history with stable unique entries", async () => {
+ const entries = await changelogSource.getEntries({ lang: "en" });
+ const release = entries.find(({ version }) => version === "0.52.2");
+
+ expect(release).toMatchObject({
+ id: "0.52.2",
+ version: "0.52.2",
+ });
+ expect(release?.body).toContain(
+ "Ignore OpenAPI `default` and `example` annotations whose values conflict with the declared schema type",
+ );
+ expect(release?.body).not.toMatch(/^- [a-f0-9]{7}: /m);
+ expect(new Set(entries.map(({ id }) => id)).size).toBe(entries.length);
+ });
+});
diff --git a/apps/docs/lib/geistdocs/changelog.ts b/apps/docs/lib/geistdocs/changelog.ts
new file mode 100644
index 000000000..14149a6cd
--- /dev/null
+++ b/apps/docs/lib/geistdocs/changelog.ts
@@ -0,0 +1,12 @@
+import { changelogSource } from "./changelog-source";
+import { config } from "./config";
+
+export const changelogOptions = {
+ config,
+ source: changelogSource,
+ path: "/changelog",
+ markdownPath: "/changelog.md",
+ pageSize: 5,
+ title: "Changelog",
+ description: "New features, breaking changes, and fixes in eve, release by release.",
+};
diff --git a/apps/docs/lib/geistdocs/llms-index.test.ts b/apps/docs/lib/geistdocs/llms-index.test.ts
index bafa57c4c..0a71ea3c7 100644
--- a/apps/docs/lib/geistdocs/llms-index.test.ts
+++ b/apps/docs/lib/geistdocs/llms-index.test.ts
@@ -26,6 +26,7 @@ describe("createLlmsIndex", () => {
expect(output).toContain("https://eve.dev/sitemap.md");
expect(output).toContain("https://eve.dev/agents.md");
expect(output).toContain("https://eve.dev/llms-full.txt");
+ expect(output).toContain("https://eve.dev/changelog.md");
});
it("uses unique absolute links and stays concise", () => {
diff --git a/apps/docs/lib/geistdocs/llms-index.ts b/apps/docs/lib/geistdocs/llms-index.ts
index 7d51eadbc..22b76b79f 100644
--- a/apps/docs/lib/geistdocs/llms-index.ts
+++ b/apps/docs/lib/geistdocs/llms-index.ts
@@ -88,6 +88,7 @@ Documentation links below point directly to Markdown. Remove the \`.md\` suffix
## Optional
+- [Changelog](${EVE_ORIGIN}/changelog.md): Read eve release notes, including breaking changes and fixes. Follow the next-page links for older releases.
- [Integrations](${EVE_ORIGIN}/integrations): Browse official channels, connections, extensions, and instrumentation providers.
- [Templates](${EVE_ORIGIN}/templates): Browse complete example projects and their source.
- [Official eve Skill](https://github.com/vercel/eve/blob/main/skills/eve/SKILL.md): Install or inspect the coding-agent skill; its guidance defers to version-matched bundled docs.
diff --git a/apps/docs/lib/geistdocs/markdown-routes.ts b/apps/docs/lib/geistdocs/markdown-routes.ts
index 7d6fb7e4b..07b3d8ff8 100644
--- a/apps/docs/lib/geistdocs/markdown-routes.ts
+++ b/apps/docs/lib/geistdocs/markdown-routes.ts
@@ -1,6 +1,8 @@
import type { GeistdocsMarkdownRoute } from "@vercel/geistdocs/proxy";
export const markdownRoutes: GeistdocsMarkdownRoute[] = [
+ { from: "/changelog/page/*path", to: "/[lang]/changelog-pages.mdx/*path" },
+ { from: "/changelog", to: "/[lang]/changelog.md" },
{ from: "/docs/*path", to: "/[lang]/llms.mdx/*path" },
{ from: "/integrations/*path", to: "/[lang]/llms.mdx/integrations/*path" },
];
diff --git a/apps/docs/next.config.ts b/apps/docs/next.config.ts
index 12b09440b..52a2c64ca 100644
--- a/apps/docs/next.config.ts
+++ b/apps/docs/next.config.ts
@@ -1,4 +1,5 @@
import { createRequire } from "node:module";
+import path from "node:path";
import { createGeistdocs } from "@vercel/geistdocs/next";
import type { NextConfig } from "next";
import {
@@ -17,6 +18,7 @@ const localSiteHost = "localhost:3000";
const config: NextConfig = {
cacheComponents: true,
partialPrefetching: true,
+ outputFileTracingRoot: path.resolve(import.meta.dirname, "../.."),
env: {
NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL:
diff --git a/apps/docs/package.json b/apps/docs/package.json
index b287baadc..00f28c08a 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -25,7 +25,7 @@
"@icons-pack/react-simple-icons": "13.13.0",
"@streamdown/code": "1.1.1",
"@vercel/analytics": "2.0.1",
- "@vercel/geistdocs": "1.27.0",
+ "@vercel/geistdocs": "1.28.0",
"@vercel/speed-insights": "2.0.0",
"@vgpu/core": "0.0.7",
"@vgpu/render": "0.0.7",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 293ed192a..ebd76ce02 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -163,8 +163,8 @@ importers:
specifier: 2.0.1
'@vercel/geistdocs':
- specifier: 1.27.0
- version: 1.27.0(0d8d476fa0b165cdc4ca646b9eff7914)
+ specifier: 1.28.0
+ version: 1.28.0(0d8d476fa0b165cdc4ca646b9eff7914)
'@vercel/speed-insights':
specifier: 2.0.0
@@ -8175,8 +8175,8 @@ packages:
'@vercel/[email protected]':
resolution: {integrity: sha512-3A98XSD/4dO9AuYL67klVPqbKGOV15r8Tet88vjs+I7m8D/Nb9+rJypY1dGyGYK+Ts+ypZVBk7f6uGiK+u2KjQ==}
- '@vercel/[email protected]':
- resolution: {integrity: sha512-AQL9q7upPgiT7rz7ImB4+cLua1DK81kT4TyBcm9ROmtn1x4d5fTDvKAtFS7D7TycYRvzUs/4/1VsIanloljxfQ==}
+ '@vercel/[email protected]':
+ resolution: {integrity: sha512-ZcfwAnZ7EKdXwjwFlHXAvdGoMT17s0+Noq7Su/7Gb8M9L3nsFsViD86nRXwnmsMFUyzEHab4dUosz8T/jFB4pA==}
hasBin: true
peerDependencies:
next: ^16.3.3
@@ -13882,6 +13882,12 @@ packages:
resolution: {integrity: sha512-XjBR15BhXuylgWGuslhDKqlSayuqvqBX91BP8pauG8kd1zY8kotkNWbXksTCNRarse4kuGbe2kIY05ARtwNIvw==}
+ resolution: {integrity: sha512-qKxVopLT/TyA6BX3Ue5NwabOsAzm0Q7kAPwq6L+wWDwisYs7R8vZ0nRXqq6rkueboxpkjvLGU9fWifiX/ZZFxQ==}
+ peerDependencies:
+ '@types/react': '>=18'
+ react: '>=18'
+
resolution: {integrity: sha512-58QSIRK6X3uw2fSTejJRnH0JuKTZl7ZJYX+sAMaYx4YTEm33gsNdnP5RuQSCnBiAvisQeErqZWAT31bR89WB6g==}
peerDependencies:
@@ -22715,7 +22721,7 @@ snapshots:
etag: 1.8.1
fs-extra: 11.1.0
- '@vercel/[email protected](0d8d476fa0b165cdc4ca646b9eff7914)':
+ '@vercel/[email protected](0d8d476fa0b165cdc4ca646b9eff7914)':
dependencies:
'@ai-sdk/react': 3.0.193([email protected])([email protected])
'@clack/prompts': 0.11.0
@@ -22746,6 +22752,7 @@ snapshots:
react: 19.2.6
react-dom: 19.2.6([email protected])
+ react-markdown: 10.1.0(@types/[email protected])([email protected])([email protected])
remark-frontmatter: 5.0.0([email protected])
remark-gfm: 4.0.1([email protected])
@@ -30782,6 +30789,24 @@ snapshots:
+ dependencies:
+ '@types/hast': 3.0.4
+ '@types/mdast': 4.0.4
+ '@types/react': 19.2.15
+ devlop: 1.1.0
+ hast-util-to-jsx-runtime: 2.3.6([email protected])
+ html-url-attributes: 3.0.1
+ mdast-util-to-hast: 13.2.1
+ react: 19.2.6
+ remark-parse: 11.0.0([email protected])
+ remark-rehype: 11.1.2
+ unified: 11.0.5
+ unist-util-visit: 5.1.0
+ vfile: 6.0.3
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
react: 19.2.6