The Open Standard for Generative UI
docs: article structured data, search titles for A2UI and comparison pages, fuller sitemap (#1405)
Zahle Khanb5b486568020
diff --git a/docs/app/blog/[slug]/page.tsx b/docs/app/blog/[slug]/page.tsxindex a0e5808bf..05e13c7f9 100644--- a/docs/app/blog/[slug]/page.tsx+++ b/docs/app/blog/[slug]/page.tsx@@ -1,8 +1,10 @@import { GitHubButton } from "@/app/(home)/components/GitHubButton/GitHubButton";import { Footer } from "@/app/(home)/sections/Footer/Footer";+import { JsonLd } from "@/components/seo/JsonLd";import { blogOgImage } from "@/lib/og/content";+import { ogImageUrl } from "@/lib/og/images";import { withOgImage } from "@/lib/page-metadata";-import { blog } from "@/lib/source";+import { BASE_URL, blog } from "@/lib/source";import { getMDXComponents } from "@/mdx-components";import { TOCProvider, TOCScrollArea } from "fumadocs-ui/components/toc";import { TOCItem, TOCItems } from "fumadocs-ui/components/toc/default";@@ -10,6 +12,44 @@ import type { Metadata } from "next";import { notFound } from "next/navigation";import { BlogFaq } from "../components/BlogFaq";+type BlogSourcePage = NonNullable<ReturnType<typeof blog.getPage>>;++/* BlogPosting and breadcrumb structured data: gives Google the post's dates and author. */+function blogStructuredData(page: BlogSourcePage) {+ const url = `${BASE_URL}${page.url}`;+ const { title, description, author, date } = page.data;+ return [+ {+ "@context": "https://schema.org",+ "@type": "BlogPosting",+ "@id": `${url}#article`,+ headline: title,+ description,+ image: `${BASE_URL}${ogImageUrl(blogOgImage(page))}`,+ datePublished: new Date(date).toISOString(),+ dateModified: new Date(date).toISOString(),+ // Bylines are a person or a team ("Thesys Engineering Team").+ author: { "@type": /\bteam\b/i.test(author) ? "Organization" : "Person", name: author },+ publisher: {+ "@type": "Organization",+ "@id": "https://www.thesys.dev/#organization",+ name: "Thesys",+ url: "https://www.thesys.dev",+ },+ mainEntityOfPage: url,+ url,+ },+ {+ "@context": "https://schema.org",+ "@type": "BreadcrumbList",+ itemListElement: [+ { "@type": "ListItem", position: 1, name: "Blog", item: `${BASE_URL}/blog` },+ { "@type": "ListItem", position: 2, name: title, item: url },+ ],+ },+ ];+}+export default async function BlogPostPage(props: { params: Promise<{ slug: string }> }) {const params = await props.params;const page = blog.getPage([params.slug]);@@ -23,6 +63,7 @@ export default async function BlogPostPage(props: { params: Promise<{ slug: strireturn (<TOCProvider toc={toc}>+ <JsonLd data={blogStructuredData(page)} />{/* Blend from the menu bar's surface color into a gray band, then back into thefooter's surface — matching the home content band (light: foreground->background->foreground;dark: black -> neutral-950 -> black, so the edges meet the black menu + footer). */}diff --git a/docs/app/components/metadata.ts b/docs/app/components/metadata.tsindex d3065d1ea..e633f36e2 100644--- a/docs/app/components/metadata.ts+++ b/docs/app/components/metadata.ts@@ -2,6 +2,8 @@ import type { PageMetadataInput } from "@/lib/page-metadata";export default {pathname: "/components",- title: "OpenUI Design System",- description: "Foundation, Blocks, and Compose documentation",+ title: "Generative UI component library",+ description:+ "The OpenUI Design System: charts, tables, form inputs and layout blocks that agents compose into Generative UI, with design foundations and a theme builder.",+ openGraph: { title: "OpenUI Design System" },} satisfies PageMetadataInput;diff --git a/docs/app/sitemap.ts b/docs/app/sitemap.tsindex 196c287d3..6dd23406f 100644--- a/docs/app/sitemap.ts+++ b/docs/app/sitemap.ts@@ -10,6 +10,13 @@ const STATIC_PATHS = ["/chat","/demo/f1-dashboard","/demo/trip-planner",+ "/demo/github",+ "/pricing",+ "/cloud/gateway",+ "/cloud/gateway/models",+ "/cloud/observability",+ "/openclaw-os",+ "/components","/blog","/benchmarks","/benchmarks/language",diff --git a/docs/components/docs-page.tsx b/docs/components/docs-page.tsxindex 28e674736..2b648b905 100644--- a/docs/components/docs-page.tsx+++ b/docs/components/docs-page.tsx@@ -1,8 +1,10 @@import { LLMCopyButton, ViewOptions } from "@/components/ai/page-actions";+import { JsonLd } from "@/components/seo/JsonLd";import { gitConfig } from "@/lib/layout.shared";import { docsOgImage } from "@/lib/og/content";+import { ogImageUrl } from "@/lib/og/images";import { withOgImage } from "@/lib/page-metadata";-import { source } from "@/lib/source";+import { BASE_URL, source } from "@/lib/source";import { getMDXComponents, MdxLink } from "@/mdx-components";import { DocsBody, DocsDescription, DocsPage, DocsTitle } from "fumadocs-ui/layouts/docs/page";import { createRelativeLink } from "fumadocs-ui/mdx";@@ -24,6 +26,7 @@ export function DocsPageView({ page }: { page: DocsSourcePage }) {// Without a sidebar there is room for the `full` page width next to the TOC (see global.css).data-no-sidebar={!page.data.sidebar || undefined}>+ <JsonLd data={docsStructuredData(page)} />{!page.data.customHeader && (<><DocsTitle>{page.data.title}</DocsTitle>@@ -57,9 +60,33 @@ export function getDocsPageMetadata(page: DocsSourcePage): Metadata {return withOgImage({ ...docsMetadata(page), description }, image, { description });}+/* TechArticle structured data: gives Google the page's last-modified date and publisher. */+function docsStructuredData(page: DocsSourcePage) {+ const url = `${BASE_URL}${page.url}`;+ return {+ "@context": "https://schema.org",+ "@type": "TechArticle",+ "@id": `${url}#article`,+ headline: page.data.title,+ description: page.data.description,+ image: `${BASE_URL}${ogImageUrl(docsOgImage(page))}`,+ ...(page.data.lastModified && {+ dateModified: new Date(page.data.lastModified).toISOString(),+ }),+ publisher: {+ "@type": "Organization",+ "@id": "https://www.thesys.dev/#organization",+ name: "Thesys",+ url: "https://www.thesys.dev",+ },+ mainEntityOfPage: url,+ url,+ };+}+function docsMetadata(page: DocsSourcePage): Metadata {return {- title: page.data.title,+ title: page.data.seoTitle ?? page.data.title,description: page.data.description,alternates: {canonical: page.url,diff --git a/docs/components/seo/JsonLd.tsx b/docs/components/seo/JsonLd.tsxnew file mode 100644index 000000000..7dcda282e--- /dev/null+++ b/docs/components/seo/JsonLd.tsx@@ -0,0 +1,12 @@+/**+ * Renders a JSON-LD structured-data block, server-rendered so crawlers see it in the initial HTML.+ * `<` is escaped so text inside the data can't close the script tag.+ */+export function JsonLd({ data }: { data: Record<string, unknown> | Record<string, unknown>[] }) {+ return (+ <script+ type="application/ld+json"+ dangerouslySetInnerHTML={{ __html: JSON.stringify(data).replaceAll("<", "\\u003c") }}+ />+ );+}diff --git a/docs/content/docs/api-reference/a2ui.mdx b/docs/content/docs/api-reference/a2ui.mdxindex 83aaed8d0..d9f5944e6 100644--- a/docs/content/docs/api-reference/a2ui.mdx+++ b/docs/content/docs/api-reference/a2ui.mdx@@ -1,5 +1,6 @@---title: "@openuidev/a2ui"+seoTitle: "A2UI v1.0 protocol client and React renderer with OpenUI Lang"description: A2UI v1.0 protocol support with OpenUI Lang component updates and an optional React renderer.---diff --git a/docs/content/docs/openui-lang/comparison.mdx b/docs/content/docs/openui-lang/comparison.mdxindex e84c2baf3..f1d9f1c9d 100644--- a/docs/content/docs/openui-lang/comparison.mdx+++ b/docs/content/docs/openui-lang/comparison.mdx@@ -1,5 +1,5 @@----title: OpenUI vs others+title: OpenUI vs A2UI vs json-render vs OpenGenerativeUIdescription: OpenUI vs json-render (Vercel), A2UI (Google), and CopilotKit OpenGenerativeUI.---diff --git a/docs/source.config.ts b/docs/source.config.tsindex 0cb2de6c4..1a093d0af 100644--- a/docs/source.config.ts+++ b/docs/source.config.ts@@ -4,6 +4,8 @@ import lastModified from "fumadocs-mdx/plugins/last-modified";import { z } from "zod";const docsPageSchema = pageSchema.extend({+ // Search title for <title>; the H1 and sidebar keep `title`.+ seoTitle: z.string().optional(),customHeader: z.boolean().optional().default(false),// Hides the previous/next page links at the bottom of the page.hideFooter: z.boolean().optional().default(false),