Skip to content

Open-source status page, incident response and uptime monitoring

chore: mdx frontmatter seo (#2277)

Maximilian Kasked450cf7638a5
diff --git a/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx b/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
index fb740ad98..287e5664b 100644
--- a/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
+++ b/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
@@ -211,7 +211,7 @@ export default async function DocsPage({
<div className="min-w-0 flex-1 space-y-8">
<DocsSubNav />
<article className="prose dark:prose-invert max-w-none">
- <h1>{doc.metadata.title}</h1>
+ <h1>{doc.metadata.hero ?? doc.metadata.title}</h1>
<CustomMDX source={doc.content} />
</article>
<div className="space-y-4">
diff --git a/apps/web/src/app/(landing)/[slug]/page.tsx b/apps/web/src/app/(landing)/[slug]/page.tsx
index 2d7b65cfa..1713d307b 100644
--- a/apps/web/src/app/(landing)/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/[slug]/page.tsx
@@ -65,7 +65,7 @@ export default async function Page({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<CustomMDX source={page.content} />
</section>
diff --git a/apps/web/src/app/(landing)/blog/[slug]/page.tsx b/apps/web/src/app/(landing)/blog/[slug]/page.tsx
index 6e199160e..2d400a238 100644
--- a/apps/web/src/app/(landing)/blog/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/blog/[slug]/page.tsx
@@ -80,7 +80,7 @@ export default async function Blog({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{post.metadata.title}</h1>
+ <h1>{post.metadata.hero ?? post.metadata.title}</h1>
<ContentMetadata data={post} />
{post.metadata.image ? (
<div className="border-border relative aspect-video w-full overflow-hidden border">
diff --git a/apps/web/src/app/(landing)/changelog/[slug]/page.tsx b/apps/web/src/app/(landing)/changelog/[slug]/page.tsx
index cecfa11b9..01a9ef56c 100644
--- a/apps/web/src/app/(landing)/changelog/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/changelog/[slug]/page.tsx
@@ -80,7 +80,7 @@ export default async function Changelog({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{post.metadata.title}</h1>
+ <h1>{post.metadata.hero ?? post.metadata.title}</h1>
<ContentMetadata data={post} />
{post.metadata.image ? (
<div className="border-border relative aspect-video w-full overflow-hidden border">
diff --git a/apps/web/src/app/(landing)/compare/[slug]/page.tsx b/apps/web/src/app/(landing)/compare/[slug]/page.tsx
index a27bb2100..f3002f408 100644
--- a/apps/web/src/app/(landing)/compare/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/compare/[slug]/page.tsx
@@ -78,7 +78,7 @@ export default async function Blog({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{post.metadata.title}</h1>
+ <h1>{post.metadata.hero ?? post.metadata.title}</h1>
<p className="text-lg">{post.metadata.description}</p>
<CustomMDX source={post.content} />
<ContentPagination prev={previousPost} next={nextPost} />
diff --git a/apps/web/src/app/(landing)/customers/[slug]/page.tsx b/apps/web/src/app/(landing)/customers/[slug]/page.tsx
index 8b796ffef..ee02d5012 100644
--- a/apps/web/src/app/(landing)/customers/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/customers/[slug]/page.tsx
@@ -74,7 +74,7 @@ export default async function CustomerPage({
className="h-8 w-auto"
/>
) : null}
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<CustomMDX source={page.content} />
</section>
);
diff --git a/apps/web/src/app/(landing)/guides/[slug]/page.tsx b/apps/web/src/app/(landing)/guides/[slug]/page.tsx
index 4e042894b..225835771 100644
--- a/apps/web/src/app/(landing)/guides/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/guides/[slug]/page.tsx
@@ -80,7 +80,7 @@ export default async function Guide({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{post.metadata.title}</h1>
+ <h1>{post.metadata.hero ?? post.metadata.title}</h1>
<ContentMetadata data={post} />
{post.metadata.image ? (
<div className="border-border relative aspect-video w-full overflow-hidden border">
diff --git a/apps/web/src/app/(landing)/page.tsx b/apps/web/src/app/(landing)/page.tsx
index 2d11430f7..b9cab94fc 100644
--- a/apps/web/src/app/(landing)/page.tsx
+++ b/apps/web/src/app/(landing)/page.tsx
@@ -31,7 +31,7 @@ export default function Page() {
return (
<div className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{homePage.metadata.title}</h1>
+ <h1>{homePage.metadata.hero ?? homePage.metadata.title}</h1>
<p className="text-lg">{homePage.metadata.description}</p>
<CustomMDX source={homePage.content} />
</div>
diff --git a/apps/web/src/app/(landing)/play/checker/page.tsx b/apps/web/src/app/(landing)/play/checker/page.tsx
index 72a35442a..7e53f3ee7 100644
--- a/apps/web/src/app/(landing)/play/checker/page.tsx
+++ b/apps/web/src/app/(landing)/play/checker/page.tsx
@@ -55,7 +55,7 @@ export default async function Page(props: {
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<CheckerProvider
defaultValues={data?.checks.sort((a, b) => a.latency - b.latency)}
diff --git a/apps/web/src/app/(landing)/play/curl/page.tsx b/apps/web/src/app/(landing)/play/curl/page.tsx
index 860cdfdca..ed05a6f8e 100644
--- a/apps/web/src/app/(landing)/play/curl/page.tsx
+++ b/apps/web/src/app/(landing)/play/curl/page.tsx
@@ -34,7 +34,7 @@ export default function Page() {
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<Form />
<CustomMDX source={page.content} />
diff --git a/apps/web/src/app/(landing)/play/mcp-health/page.tsx b/apps/web/src/app/(landing)/play/mcp-health/page.tsx
index 5e198fe38..c6fff2e65 100644
--- a/apps/web/src/app/(landing)/play/mcp-health/page.tsx
+++ b/apps/web/src/app/(landing)/play/mcp-health/page.tsx
@@ -53,7 +53,7 @@ export default async function Page(props: {
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<McpHealthProvider defaultReport={sharedReport}>
<Form defaultUrl={sharedReport?.url ?? ""} />
diff --git a/apps/web/src/app/(landing)/play/severity-matrix/page.tsx b/apps/web/src/app/(landing)/play/severity-matrix/page.tsx
index a8b0f92a0..e3d57b2d5 100644
--- a/apps/web/src/app/(landing)/play/severity-matrix/page.tsx
+++ b/apps/web/src/app/(landing)/play/severity-matrix/page.tsx
@@ -34,7 +34,7 @@ export default function Page() {
return (
<section className="prose dark:prose-invert max-w-none space-y-4">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<SeverityMatrixBuilder />
<CustomMDX source={page.content} />
diff --git a/apps/web/src/app/(landing)/play/uptime-sla/page.tsx b/apps/web/src/app/(landing)/play/uptime-sla/page.tsx
index 918fa85bb..aa88a7c7a 100644
--- a/apps/web/src/app/(landing)/play/uptime-sla/page.tsx
+++ b/apps/web/src/app/(landing)/play/uptime-sla/page.tsx
@@ -34,7 +34,7 @@ export default function Page() {
return (
<section className="prose dark:prose-invert max-w-none space-y-4">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<Calculation />
<CustomMDX source={page.content} />
diff --git a/apps/web/src/app/(landing)/tooling/[slug]/page.tsx b/apps/web/src/app/(landing)/tooling/[slug]/page.tsx
index 62386993d..55e79dc44 100644
--- a/apps/web/src/app/(landing)/tooling/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/tooling/[slug]/page.tsx
@@ -67,7 +67,7 @@ export default async function ToolingPage({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<CustomMDX source={page.content} />
</section>
diff --git a/apps/web/src/app/(landing)/use-case/[slug]/page.tsx b/apps/web/src/app/(landing)/use-case/[slug]/page.tsx
index 33b275157..a7855b950 100644
--- a/apps/web/src/app/(landing)/use-case/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/use-case/[slug]/page.tsx
@@ -80,7 +80,7 @@ export default async function UseCase({
return (
<section className="prose dark:prose-invert max-w-none">
<JsonLd graph={jsonLDGraph} />
- <h1>{post.metadata.title}</h1>
+ <h1>{post.metadata.hero ?? post.metadata.title}</h1>
<ContentMetadata data={post} />
{post.metadata.image ? (
<div className="border-border relative aspect-video w-full overflow-hidden border">
diff --git a/apps/web/src/app/not-found.tsx b/apps/web/src/app/not-found.tsx
index 23718752b..6902b4b58 100644
--- a/apps/web/src/app/not-found.tsx
+++ b/apps/web/src/app/not-found.tsx
@@ -5,7 +5,7 @@ export default function NotFound() {
const page = getUnrelatedPage("not-found");
return (
<section className="prose dark:prose-invert max-w-none">
- <h1>{page.metadata.title}</h1>
+ <h1>{page.metadata.hero ?? page.metadata.title}</h1>
<p className="text-lg">{page.metadata.description}</p>
<CustomMDX source={page.content} />
</section>
diff --git a/apps/web/src/content/utils/schema.ts b/apps/web/src/content/utils/schema.ts
index 4a865bb68..88502a937 100644
--- a/apps/web/src/content/utils/schema.ts
+++ b/apps/web/src/content/utils/schema.ts
@@ -18,19 +18,36 @@ const faqItemSchema = z.object({
answer: z.string(),
});
+// Per-page SEO/social overrides. Each falls back to its top-level twin
+// (seo.title ?? title, seo.description ?? description); the rest are opt-in.
+const seoSchema = z
+ .object({
+ title: z.string(),
+ description: z.string(),
+ ogImage: z.string(),
+ noindex: z.boolean(),
+ canonical: z.string(),
+ })
+ .partial();
+
export const metadataSchema = z.object({
title: z.string(),
+ // Visible page heading; falls back to `title`. Lets the on-page h1 differ
+ // from the canonical `title` used for SEO, breadcrumbs, search, and nav.
+ hero: z.string().optional(),
publishedAt: z.coerce.date(),
description: z.string(),
category: z.string(),
author: z.string(),
image: z.string().optional(),
+ seo: seoSchema.optional(),
// Structured data fields
howto: howtoSchema.optional(),
faq: z.array(faqItemSchema).optional(),
});
export type Metadata = z.infer<typeof metadataSchema>;
+export type SeoData = z.infer<typeof seoSchema>;
export type HowToStep = z.infer<typeof howtoStepSchema>;
export type HowToData = z.infer<typeof howtoSchema>;
export type FAQItem = z.infer<typeof faqItemSchema>;
diff --git a/apps/web/src/lib/metadata/shared-metadata.ts b/apps/web/src/lib/metadata/shared-metadata.ts
index bb3d96a27..db9d7981f 100644
--- a/apps/web/src/lib/metadata/shared-metadata.ts
+++ b/apps/web/src/lib/metadata/shared-metadata.ts
@@ -51,12 +51,14 @@ export const getSocialMetadata = (args: {
description: string;
url: string;
category?: string;
+ ogImage?: string;
}): Pick<Metadata, "openGraph" | "twitter"> => {
- const { title, description, url, category } = args;
+ const { title, description, url, category, ogImage: ogImageOverride } = args;
const searchParams = new URLSearchParams({ title, description });
if (category) searchParams.set("category", category);
- const ogImage = `${BASE_URL}/api/og?${searchParams.toString()}`;
+ const ogImage =
+ ogImageOverride ?? `${BASE_URL}/api/og?${searchParams.toString()}`;
return {
openGraph: {
@@ -81,25 +83,31 @@ export const getSocialMetadata = (args: {
export const getPageMetadata = (page: MDXData, basePath?: string): Metadata => {
const { slug, metadata } = page;
- const { title, description, category, publishedAt } = metadata;
+ const { title, description, category, publishedAt, seo } = metadata;
const url = basePath
? `${BASE_URL}/${basePath}/${slug}`
: `${BASE_URL}/${slug}`;
+ const metaTitle = seo?.title ?? title;
+ const metaDescription = seo?.description ?? description;
+
const { openGraph, twitter } = getSocialMetadata({
- title,
- description,
+ title: metaTitle,
+ description: metaDescription,
url,
category,
+ ogImage: seo?.ogImage,
});
return {
- title,
- description,
+ // `absolute` bypasses the `%s | openstatus` template so the override is verbatim
+ title: seo?.title ? { absolute: seo.title } : title,
+ description: metaDescription,
alternates: {
- canonical: url,
+ canonical: seo?.canonical ?? url,
},
+ ...(seo?.noindex ? { robots: { index: false } } : {}),
openGraph: {
...openGraph,
type: "article",