Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

docs: use beta label for legal notice (#17)

Allen Zhouc1645494c09a
diff --git a/apps/docs/app/[lang]/(home)/page.tsx b/apps/docs/app/[lang]/(home)/page.tsx
index 461863e11..9378f5ece 100644
--- a/apps/docs/app/[lang]/(home)/page.tsx
+++ b/apps/docs/app/[lang]/(home)/page.tsx
@@ -22,9 +22,9 @@ const HomePage = () => (
<section className="relative flex flex-col items-center px-4 pb-32 pt-32 text-center sm:px-12">
<Link
href={betaAgreementHref}
- className="mb-6 rounded-full border border-amber-300 px-3 py-1 font-medium text-amber-700 text-xs transition-colors hover:bg-amber-50"
+ className="mb-6 rounded-full border border-blue-300 px-3 py-1 font-medium text-blue-700 text-xs transition-colors hover:bg-blue-50"
>
- Public preview
+ Beta
</Link>
<h1 className="max-w-3xl text-5xl font-bold text-gray-1000 sm:text-6xl xl:text-7xl">
The Framework
diff --git a/apps/docs/app/[lang]/layout.tsx b/apps/docs/app/[lang]/layout.tsx
index 1be076122..820695259 100644
--- a/apps/docs/app/[lang]/layout.tsx
+++ b/apps/docs/app/[lang]/layout.tsx
@@ -1,7 +1,7 @@
import "../global.css";
-import { Footer } from "@vercel/geistdocs/footer";
import { Navbar } from "@vercel/geistdocs/navbar";
import type { Metadata } from "next";
+import { Footer } from "@/components/geistdocs/footer";
import { GeistdocsProvider } from "@/components/geistdocs/provider";
import { config } from "@/lib/geistdocs/config";
import { mono, sans } from "@/lib/geistdocs/fonts";
diff --git a/apps/docs/components/geistdocs/docs-layout.tsx b/apps/docs/components/geistdocs/docs-layout.tsx
index f93da73a3..97d33de2e 100644
--- a/apps/docs/components/geistdocs/docs-layout.tsx
+++ b/apps/docs/components/geistdocs/docs-layout.tsx
@@ -15,19 +15,6 @@ export const DocsLayout = ({ tree, children }: DocsLayoutProps) => (
}}
tree={tree}
>
- <aside className="mx-auto w-full max-w-[900px] px-4 pt-6 md:px-6 md:pt-8 xl:px-8 xl:pt-10 [grid-column:main]">
- <div className="border-amber-600 border-l pl-4 text-gray-900 text-sm leading-6">
- <span className="font-medium text-gray-1000">Public preview.</span> Eve is currently a
- preview and subject to the{" "}
- <a
- className="font-medium text-gray-1000 underline decoration-gray-600/40 underline-offset-4 transition-colors hover:decoration-gray-1000"
- href="https://vercel.com/docs/release-phases/public-beta-agreement"
- >
- Vercel beta terms
- </a>
- ; the framework, APIs, documentation, and behavior may change before general availability.
- </div>
- </aside>
{children}
</PackageDocsLayout>
);
diff --git a/apps/docs/components/geistdocs/footer.tsx b/apps/docs/components/geistdocs/footer.tsx
new file mode 100644
index 000000000..25e22d8a9
--- /dev/null
+++ b/apps/docs/components/geistdocs/footer.tsx
@@ -0,0 +1,56 @@
+import { SiGithub, SiVercel } from "@icons-pack/react-simple-icons";
+import { Button } from "@vercel/geistdocs/components/button";
+import { LanguageSelector, ThemeToggle } from "@vercel/geistdocs/controls";
+import type { GeistdocsConfig } from "@vercel/geistdocs/config";
+import { RssIcon } from "lucide-react";
+import Link from "next/link";
+
+interface FooterProps {
+ config: Pick<GeistdocsConfig, "github">;
+ copyright?: string;
+}
+
+export const Footer = ({
+ config,
+ copyright = `Copyright Vercel ${new Date().getFullYear()}. All rights reserved.`,
+}: FooterProps) => {
+ const githubUrl =
+ config.github?.owner && config.github.repo
+ ? `https://github.com/${config.github.owner}/${config.github.repo}`
+ : undefined;
+
+ return (
+ <footer className="border-t px-4 py-5 md:px-6">
+ <div className="mx-auto flex max-w-[1448px] flex-col items-center justify-between gap-4 sm:flex-row">
+ <div className="flex flex-wrap items-center justify-center gap-x-3 gap-y-2 text-gray-800 text-sm sm:justify-start">
+ <span className="flex items-center gap-2">
+ <SiVercel className="size-4 shrink-0" />
+ <span className="text-center sm:text-left">{copyright}</span>
+ </span>
+ <Link
+ className="font-medium text-gray-900 underline-offset-4 transition-colors hover:text-gray-1000 hover:underline"
+ href="/docs/responsible-use"
+ >
+ Responsible Use
+ </Link>
+ </div>
+ <div className="flex items-center gap-2">
+ <LanguageSelector />
+ <Button asChild size="icon-sm" type="button" variant="ghost">
+ <a href="/rss.xml" rel="noopener" target="_blank">
+ <RssIcon className="size-4" />
+ </a>
+ </Button>
+ {githubUrl ? (
+ <Button asChild size="icon-sm" type="button" variant="ghost">
+ <a href={githubUrl} rel="noopener" target="_blank">
+ <SiGithub className="size-4" />
+ </a>
+ </Button>
+ ) : null}
+ <ThemeToggle />
+ </div>
+ </div>
+ </footer>
+ );
+};
diff --git a/apps/docs/geistdocs.tsx b/apps/docs/geistdocs.tsx
index 8f751df23..52fa814e0 100644
--- a/apps/docs/geistdocs.tsx
+++ b/apps/docs/geistdocs.tsx
@@ -1,8 +1,8 @@
export const Logo = () => (
<span className="flex items-center gap-2">
<span className="font-semibold text-gray-1000 text-lg leading-none">Eve</span>
- <span className="rounded-full border border-amber-300 px-2 py-0.5 font-medium text-amber-700 text-xs leading-none">
- Public preview
+ <span className="rounded-full border border-blue-300 px-2 py-0.5 font-medium text-blue-700 text-xs leading-none">
+ Beta
</span>
</span>
);
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
index 760aadff8..c90302119 100644
--- a/docs/getting-started.mdx
+++ b/docs/getting-started.mdx
@@ -5,8 +5,6 @@ description: "Install Eve, scaffold your first agent, give it a tool, and run it
Eve is a filesystem-first framework for durable agents. You write capabilities under `agent/`, and Eve runs the model loop, persists every session, and serves the agent over HTTP and platform channels. You'll scaffold an app, add a tool, run it locally, then create, stream, and continue a session over HTTP.
-Eve is currently in beta and subject to the [Vercel beta terms](https://vercel.com/docs/release-phases/public-beta-agreement). The framework, APIs, documentation, and behavior may change before general availability.
-
## Prerequisites
- Node 24 or newer
diff --git a/docs/introduction.md b/docs/introduction.mdx
similarity index 95%
rename from docs/introduction.md
rename to docs/introduction.mdx
index 57372e3d5..93e32b7f2 100644
--- a/docs/introduction.md
+++ b/docs/introduction.mdx
@@ -7,7 +7,9 @@ Eve is a framework for building durable agents as ordinary files in a TypeScript
Instead of one large configuration object, each part of your agent gets a clear home. Instructions go in one file, tools in one folder, channels in another. Eve discovers that structure and turns it into an agent that runs locally, serves HTTP, connects to other platforms, and keeps working across many turns.
-Eve is currently in beta and subject to the [Vercel beta terms](https://vercel.com/docs/release-phases/public-beta-agreement). The framework, APIs, documentation, and behavior may change before general availability.
+<Callout>
+ Eve is currently in beta and subject to the [Vercel beta terms](https://vercel.com/docs/release-phases/public-beta-agreement); the framework, APIs, documentation, and behavior may change before general availability.
+</Callout>
## An Eve project at a glance
diff --git a/docs/meta.json b/docs/meta.json
index fa87f14c0..ae2a88f05 100644
--- a/docs/meta.json
+++ b/docs/meta.json
@@ -2,7 +2,6 @@
"pages": [
"introduction",
"getting-started",
- "legal",
"---",
"agent-config",
"instructions",
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
index b70d3668c..a21ce07ad 100644
--- a/docs/reference/cli.md
+++ b/docs/reference/cli.md
@@ -5,8 +5,6 @@ description: "Reference for every eve CLI command: init, info, build, start, dev
The `eve` binary (`bin: eve`) runs from your app root, and every command first loads `.env`/`.env.local` from that root. Running `eve` with no command runs `eve dev`.
-Eve is currently a preview and subject to the Vercel beta terms; the framework, APIs, documentation, and behavior may change before general availability.
-
## Commands
| Command | Description |
diff --git a/docs/legal.md b/docs/responsible-use.md
similarity index 77%
rename from docs/legal.md
rename to docs/responsible-use.md
index 1f897e001..e9f38b7be 100644
--- a/docs/legal.md
+++ b/docs/responsible-use.md
@@ -1,10 +1,8 @@
---
-title: "Legal"
-description: "Preview status, deployer responsibility, and safeguards to review before using Eve with sensitive, regulated, or production data."
+title: "Responsible Use"
+description: "Deployer responsibility and safeguards to review before using Eve with sensitive, regulated, or production data."
---
-Eve is currently a preview and subject to the Vercel beta terms; the framework, APIs, documentation, and behavior may change before general availability.
-
As the deployer, it is your responsibility to ensure your agent complies with applicable laws.
You are responsible for configuring approval policies, tool restrictions, connection scopes, route/session authorization, sandbox controls, telemetry exports, and other safeguards appropriate for your use case.
diff --git a/scripts/check-docs.mjs b/scripts/check-docs.mjs
index 4374d7cc7..0e8bfcaef 100755
--- a/scripts/check-docs.mjs
+++ b/scripts/check-docs.mjs
@@ -13,9 +13,10 @@
*
* 2. For roots whose ordering is driven by `meta.json` (i.e. /docs),
* every site-page markdown file must be reachable from the sidebar nav
- * — either listed by slug in an ancestor `meta.json#pages`, or covered
- * by a `"..."` token in that array. Otherwise the page renders at its
- * URL but never appears in the sidebar (easy to miss in review).
+ * — either listed by slug in an ancestor `meta.json#pages`, covered
+ * by a `"..."` token in that array, or explicitly allowed as a
+ * footer-only page. Otherwise the page renders at its URL but never
+ * appears in the sidebar (easy to miss in review).
*
* Files intentionally not part of the site (the top-level engineer-facing
* README.md in each root) are skipped via isExcluded().
@@ -33,10 +34,16 @@ const ROOTS = [
},
];
+const SIDEBAR_EXEMPT_PAGES = new Set([
+ // Linked from the global footer instead of the docs sidebar.
+ "responsible-use.md",
+]);
+
// Only the top-level README.md is excluded. Nested READMEs (e.g.
// channels/README.md) are site pages and must carry a `url:` frontmatter
// override, validated below.
const isExcluded = (relPath) => relPath === "README.md";
+const isSidebarExempt = (relPath) => SIDEBAR_EXEMPT_PAGES.has(relPath);
function walkMarkdown(dir) {
const out = [];
@@ -169,7 +176,7 @@ for (const root of ROOTS) {
issue: `frontmatter missing \`${field}\``,
});
}
- if (nav && !isCoveredByNav(relPath, nav)) {
+ if (nav && !isSidebarExempt(relPath) && !isCoveredByNav(relPath, nav)) {
failures.push({
root: root.label,
file: relPath,
@@ -252,7 +259,7 @@ process.stderr.write(
" 1. Start with frontmatter containing `title` and `description`.",
" 2. Be reachable from the sidebar nav via an ancestor meta.json —",
' either listed by slug in `pages[]`, or covered by a `"..."`',
- " wildcard entry.",
+ " wildcard entry, unless explicitly allowed as footer-only.",
"",
"Files intentionally kept off the site (engineer-facing READMEs, etc.)",
"should be excluded by updating isExcluded() in scripts/check-docs.mjs.",