Skip to content

The Open Standard for Generative UI

Add overview page in docs (#919)

abhithesys9c874f50d680
diff --git a/docs/README.md b/docs/README.md
index 332d32d37..a09742a0e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -155,7 +155,7 @@ Active component-preview specific modules are located under `app/components/` an
### Navigation
-A custom `DocsNavbar` component (`components/docs-navbar.tsx`) provides top-level horizontal tabs: OpenUI, Agent Interface, API Reference. It replaces Fumadocs' default nav and is used across the docs pages.
+A custom `DocsNavbar` component (`components/docs-navbar.tsx`) provides top-level horizontal tabs: Overview, OpenUI, Agent Interface, OpenUI Cloud, and API Reference. It replaces Fumadocs' default nav and is used across the docs pages.
## Path aliases
diff --git a/docs/components/docs-navbar.tsx b/docs/components/docs-navbar.tsx
index 72e775be8..a3600b08f 100644
--- a/docs/components/docs-navbar.tsx
+++ b/docs/components/docs-navbar.tsx
@@ -13,6 +13,7 @@ import { SiteHeaderFrame } from "./site-header";
import { ThemeToggle } from "./theme-toggle";
const tabs: { title: string; url: string; match?: string }[] = [
+ { title: "Overview", url: "/docs/overview" },
{ title: "OpenUI", url: "/docs/openui-lang" },
{
title: "Agent Interface",
diff --git a/docs/components/docs-route-layout.tsx b/docs/components/docs-route-layout.tsx
index ae0fc28b4..5943a18b0 100644
--- a/docs/components/docs-route-layout.tsx
+++ b/docs/components/docs-route-layout.tsx
@@ -5,6 +5,7 @@ import { baseOptions, siteConfig } from "@/lib/layout.shared";
import { DocsLayout } from "fumadocs-ui/layouts/docs";
import { Play, Plug } from "lucide-react";
import Link from "next/link";
+import { usePathname } from "next/navigation";
import type { ReactNode } from "react";
function SidebarBannerLink({
@@ -39,14 +40,17 @@ type DocsRouteLayoutProps = {
};
export function DocsRouteLayout({ tree, children }: DocsRouteLayoutProps) {
+ const pathname = usePathname();
+ const isOverview = pathname === "/docs/overview";
+
return (
<DocsLayout
tree={tree}
{...baseOptions()}
- nav={{ component: <DocsNavbar showSidebarToggle /> }}
+ nav={{ component: <DocsNavbar showSidebarToggle={!isOverview} /> }}
sidebar={{
tabs: false,
- enabled: true,
+ enabled: !isOverview,
collapsible: false,
banner: (
<div className="flex flex-col mb-2">
diff --git a/docs/components/openui-architecture-overview.module.css b/docs/components/openui-architecture-overview.module.css
new file mode 100644
index 000000000..6d2dcf5ab
--- /dev/null
+++ b/docs/components/openui-architecture-overview.module.css
@@ -0,0 +1,322 @@
+.layout {
+ display: grid;
+ grid-template-columns: minmax(0, 1.08fr) minmax(340px, 0.92fr);
+ gap: clamp(2.5rem, 5vw, 4.75rem);
+ align-items: start;
+ margin-top: 3rem;
+}
+
+.diagramColumn {
+ position: sticky;
+ top: 9.25rem;
+}
+
+.diagram {
+ position: relative;
+ display: flex;
+ flex-direction: column;
+ margin: 0;
+ padding: clamp(1.25rem, 2.5vw, 2rem);
+ overflow: hidden;
+ border: 1px solid var(--openui-border-default);
+ border-radius: 1.25rem;
+ background-color: var(--color-doc-surface);
+ background-image:
+ linear-gradient(
+ color-mix(in srgb, var(--openui-border-default) 45%, transparent) 1px,
+ transparent 1px
+ ),
+ linear-gradient(
+ 90deg,
+ color-mix(in srgb, var(--openui-border-default) 45%, transparent) 1px,
+ transparent 1px
+ );
+ background-size: 2.25rem 2.25rem;
+ box-shadow: 0 1.5rem 3.5rem color-mix(in srgb, var(--openui-text-neutral-primary) 8%, transparent);
+}
+
+.surfaceRow,
+.frameworkRow,
+.providerRow,
+.backendRow {
+ position: relative;
+ z-index: 1;
+ display: grid;
+ gap: 0.625rem;
+}
+
+.surfaceRow {
+ grid-template-columns: repeat(4, minmax(0, 1fr));
+}
+
+.frameworkRow,
+.providerRow {
+ grid-template-columns: repeat(3, minmax(0, 1fr));
+}
+
+.backendRow {
+ grid-template-columns: repeat(2, minmax(0, 1fr));
+}
+
+.node,
+.providerNode,
+.backendNode {
+ border: 1px solid color-mix(in srgb, var(--openui-text-neutral-primary) 72%, transparent);
+ background: color-mix(in srgb, var(--color-doc-surface) 94%, var(--openui-highlight));
+ color: var(--openui-text-neutral-primary);
+ box-shadow: 0 0.25rem 0.75rem
+ color-mix(in srgb, var(--openui-text-neutral-primary) 5%, transparent);
+}
+
+.node {
+ display: flex;
+ min-height: 4rem;
+ align-items: center;
+ justify-content: center;
+ padding: 0.75rem;
+ border-radius: 0.75rem;
+ font-size: 0.8125rem;
+ font-weight: 600;
+ line-height: 1.2;
+ text-align: center;
+}
+
+.nodeAgent {
+ background: #c8f64b;
+ color: #17200b;
+}
+
+.nodeRuntime {
+ position: relative;
+ z-index: 1;
+ min-height: 5rem;
+ border-color: #5f7095;
+ border-radius: 0.875rem;
+ background: #dbe4ff;
+ color: #17213a;
+ font-size: 1rem;
+}
+
+.runtimeTag {
+ position: absolute;
+ top: -0.75rem;
+ right: 1rem;
+ display: inline-flex;
+ height: 1.5rem;
+ align-items: center;
+ gap: 0.3rem;
+ padding: 0 0.625rem;
+ border: 1px solid #5f7095;
+ border-radius: 999px;
+ background: #17213a;
+ color: #ffffff;
+ font-size: 0.6875rem;
+ font-weight: 650;
+ letter-spacing: 0.04em;
+ line-height: 1;
+ text-transform: uppercase;
+}
+
+.connector {
+ position: relative;
+ z-index: 0;
+ display: flex;
+ height: 2.5rem;
+ align-items: center;
+ justify-content: center;
+ color: var(--openui-text-neutral-tertiary);
+}
+
+.connector::before {
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 50%;
+ width: 1px;
+ background: var(--openui-border-interactive-emphasis);
+ content: "";
+ transform: translateX(-50%);
+}
+
+.connector svg {
+ position: relative;
+ padding: 0.125rem;
+ background: var(--color-doc-surface);
+}
+
+.backendNode {
+ display: flex;
+ min-height: 8.25rem;
+ flex-direction: column;
+ justify-content: space-between;
+ gap: 1rem;
+ padding: 1.125rem;
+ border-radius: 0.875rem;
+}
+
+.backendNode strong {
+ font-size: 1rem;
+ font-weight: 650;
+ letter-spacing: -0.02em;
+}
+
+.backendNode span {
+ color: color-mix(in srgb, currentColor 70%, transparent);
+ font-size: 0.75rem;
+ line-height: 1.55;
+}
+
+.nodeCloud {
+ border-color: #7c6fb0;
+ background: #e4ddff;
+ color: #251d45;
+}
+
+.nodeManaged {
+ background: color-mix(in srgb, var(--color-doc-surface) 88%, var(--openui-highlight));
+}
+
+.providerNode {
+ display: flex;
+ min-height: 3.25rem;
+ align-items: center;
+ justify-content: center;
+ padding: 0.625rem;
+ border-radius: 999px;
+ font-size: 0.75rem;
+ font-weight: 600;
+ text-align: center;
+}
+
+.explanations {
+ border-top: 1px solid var(--openui-border-default);
+}
+
+.explanation {
+ display: grid;
+ grid-template-columns: 2.5rem minmax(0, 1fr);
+ gap: 1rem;
+ padding: 2.25rem 0 2.5rem;
+ border-bottom: 1px solid var(--openui-border-default);
+}
+
+.number {
+ padding-top: 0.35rem;
+ color: var(--openui-text-brand);
+ font-size: 0.8125rem;
+ font-weight: 650;
+ line-height: 1;
+}
+
+.explanationBody h2 {
+ margin: 0;
+ color: var(--openui-text-neutral-primary);
+ font-size: clamp(1.25rem, 2vw, 1.5rem);
+ font-weight: 650;
+ letter-spacing: -0.045em;
+ line-height: 1.05;
+}
+
+.explanationBody p {
+ margin: 1rem 0 0;
+ color: var(--openui-text-neutral-secondary);
+ font-size: 1rem;
+ line-height: 1.65;
+}
+
+.explanationLink {
+ display: inline-flex;
+ align-items: center;
+ gap: 0.45rem;
+ margin-top: 1.25rem;
+ color: var(--openui-text-neutral-primary);
+ font-size: 0.875rem;
+ font-weight: 650;
+ text-decoration: none;
+}
+
+.explanationLink svg {
+ transition: transform 160ms ease;
+}
+
+.explanationLink:hover svg {
+ transform: translateX(0.2rem);
+}
+
+.explanationLink:focus-visible {
+ border-radius: 0.25rem;
+ outline: 2px solid var(--openui-border-accent-emphasis);
+ outline-offset: 0.25rem;
+}
+
+@media (max-width: 980px) {
+ .layout {
+ grid-template-columns: 1fr;
+ gap: 2.75rem;
+ }
+
+ .diagramColumn {
+ position: static;
+ }
+
+ .explanation {
+ grid-template-columns: 2.25rem minmax(0, 1fr);
+ }
+}
+
+@media (max-width: 600px) {
+ .layout {
+ margin-top: 2.25rem;
+ }
+
+ .diagram {
+ padding: 1rem;
+ border-radius: 1rem;
+ background-size: 1.75rem 1.75rem;
+ }
+
+ .surfaceRow {
+ grid-template-columns: repeat(2, minmax(0, 1fr));
+ }
+
+ .frameworkRow {
+ grid-template-columns: 1fr;
+ }
+
+ .backendRow {
+ grid-template-columns: 1fr;
+ }
+
+ .backendNode {
+ min-height: 6.5rem;
+ }
+
+ .providerRow {
+ gap: 0.4rem;
+ }
+
+ .providerNode {
+ padding-inline: 0.35rem;
+ font-size: 0.6875rem;
+ }
+
+ .explanation {
+ grid-template-columns: 2rem minmax(0, 1fr);
+ gap: 0.75rem;
+ padding: 1.75rem 0 2rem;
+ }
+
+ .explanationBody h2 {
+ font-size: 1.75rem;
+ }
+
+ .explanationBody p {
+ font-size: 0.9375rem;
+ }
+}
+
+@media (prefers-reduced-motion: reduce) {
+ .explanationLink svg {
+ transition: none;
+ }
+}
diff --git a/docs/components/openui-architecture-overview.tsx b/docs/components/openui-architecture-overview.tsx
new file mode 100644
index 000000000..2739d40ba
--- /dev/null
+++ b/docs/components/openui-architecture-overview.tsx
@@ -0,0 +1,126 @@
+import { ArrowDownUp, ArrowRight, Sparkles } from "lucide-react";
+import Link from "next/link";
+import styles from "./openui-architecture-overview.module.css";
+
+type ProductExplanation = {
+ number: string;
+ title: string;
+ description: string;
+ href: string;
+ linkLabel: string;
+};
+
+const explanations: ProductExplanation[] = [
+ {
+ number: "01",
+ title: "Agent Interface",
+ description:
+ "Agent Interface is a frontend SDK for building agentic experiences. It includes streaming conversations, thread history, native support for generative UI, and an artifact workspace without requiring you to assemble the application shell from scratch.",
+ href: "/docs/agent/getting-started/introduction",
+ linkLabel: "Explore Agent Interface",
+ },
+ {
+ number: "02",
+ title: "OpenUI Lang",
+ description:
+ "OpenUI Lang is an open-source, streaming-first language and runtime for generative UI. Agents compose interfaces from your component library, while the runtime parses and renders their output progressively as it streams.",
+ href: "/docs/openui-lang",
+ linkLabel: "Explore OpenUI Lang",
+ },
+ {
+ number: "03",
+ title: "OpenUI Cloud",
+ description:
+ "OpenUI Cloud is the managed backend for OpenUI. It provides model access and automatic fallbacks, validates generated output, persists conversations and artifacts, and includes built-in tools, reports, and presentations.",
+ href: "/docs/openui-cloud",
+ linkLabel: "Explore OpenUI Cloud",
+ },
+];
+
+function Connector() {
+ return (
+ <div className={styles.connector} aria-hidden="true">
+ <ArrowDownUp size={18} strokeWidth={1.6} />
+ </div>
+ );
+}
+
+function ArchitectureDiagram() {
+ return (
+ <figure className={styles.diagram} aria-label="OpenUI architecture and ecosystem">
+ <div className={styles.surfaceRow}>
+ <div className={`${styles.node} ${styles.nodeAgent}`}>Agent Interface</div>
+ <div className={styles.node}>CopilotKit</div>
+ <div className={styles.node}>assistant-ui</div>
+ <div className={styles.node}>Custom</div>
+ </div>
+
+ <Connector />
+
+ <div className={`${styles.node} ${styles.nodeRuntime}`}>
+ <span className={styles.runtimeTag}>
+ <Sparkles size={12} strokeWidth={2} aria-hidden="true" />
+ Gen UI
+ </span>
+ OpenUI Lang runtime
+ </div>
+
+ <Connector />
+
+ <div className={styles.frameworkRow}>
+ <div className={styles.node}>LangGraph</div>
+ <div className={styles.node}>Mastra</div>
+ <div className={styles.node}>Vercel AI SDK</div>
+ </div>
+
+ <Connector />
+
+ <div className={styles.backendRow}>
+ <div className={`${styles.backendNode} ${styles.nodeCloud}`}>
+ <strong>OpenUI Cloud</strong>
+ <span>Models · validation · persistence · built-in artifacts</span>
+ </div>
+ <div className={`${styles.backendNode} ${styles.nodeManaged}`}>
+ <strong>Self-managed</strong>
+ <span>Provider · API route · storage · tools</span>
+ </div>
+ </div>
+
+ <Connector />
+
+ <div className={styles.providerRow}>
+ <div className={styles.providerNode}>Anthropic</div>
+ <div className={styles.providerNode}>OpenAI</div>
+ <div className={styles.providerNode}>Google Gemini</div>
+ </div>
+ </figure>
+ );
+}
+
+export function OpenUIArchitectureOverview() {
+ return (
+ <section className={styles.layout} aria-label="OpenUI products and architecture">
+ <div className={styles.diagramColumn}>
+ <ArchitectureDiagram />
+ </div>
+
+ <div className={styles.explanations}>
+ {explanations.map((item) => (
+ <article className={styles.explanation} key={item.number}>
+ <span className={styles.number} aria-hidden="true">
+ {item.number}
+ </span>
+ <div className={styles.explanationBody}>
+ <h2>{item.title}</h2>
+ <p>{item.description}</p>
+ <Link href={item.href} className={styles.explanationLink}>
+ {item.linkLabel}
+ <ArrowRight size={17} strokeWidth={2} aria-hidden="true" />
+ </Link>
+ </div>
+ </article>
+ ))}
+ </div>
+ </section>
+ );
+}
diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json
index b8f4e2046..9d8d002f9 100644
--- a/docs/content/docs/meta.json
+++ b/docs/content/docs/meta.json
@@ -1,6 +1,7 @@
{
"title": "OpenUI",
"pages": [
+ "overview",
"openui-lang",
"components",
"agent",
diff --git a/docs/content/docs/overview/index.mdx b/docs/content/docs/overview/index.mdx
new file mode 100644
index 000000000..93a88b5ec
--- /dev/null
+++ b/docs/content/docs/overview/index.mdx
@@ -0,0 +1,9 @@
+---
+title: Overview
+description: "OpenUI is a generative UI toolkit for building agents that respond with interactive interfaces, not just text. Agents compose the interface best suited to each request, from inline forms and data visualizations to dashboards, reports, and presentations."
+full: true
+---
+
+import { OpenUIArchitectureOverview } from "@/components/openui-architecture-overview";
+
+<OpenUIArchitectureOverview />
diff --git a/docs/content/docs/overview/meta.json b/docs/content/docs/overview/meta.json
new file mode 100644
index 000000000..5d12ffcb6
--- /dev/null
+++ b/docs/content/docs/overview/meta.json
@@ -0,0 +1,5 @@
+{
+ "title": "Overview",
+ "root": true,
+ "pages": ["index"]
+}
diff --git a/docs/next.config.mjs b/docs/next.config.mjs
index a982d7cad..658ad90df 100644
--- a/docs/next.config.mjs
+++ b/docs/next.config.mjs
@@ -51,7 +51,7 @@ const config = {
},
{
source: "/docs",
- destination: "/docs/openui-lang",
+ destination: "/docs/overview",
permanent: false,
},
{