Skip to content

fix(docs): improve OpenGraph metadata for better social sharing #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pranaygp wants to merge 1 commit into
base: main
Choose a base branch
from
+59 −6
Draft

fix(docs): improve OpenGraph metadata for better social sharing #920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/og-metadata-improvements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"docs": patch
---

Improve OpenGraph metadata: fix image dimensions to recommended 1200x630, add global Twitter/OG metadata, include width/height/alt on all OG images
9 changes: 8 additions & 1 deletion docs/app/[lang]/(home)/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ export const metadata: Metadata = {
canonical: '/',
},
openGraph: {
images: ['/og'],
images: [
{
url: '/og',
width: 1200,
height: 630,
alt: 'Workflow DevKit - Make any TypeScript Function Durable',
},
],
},
};

Expand Down
9 changes: 8 additions & 1 deletion docs/app/[lang]/docs/[[...slug]]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,14 @@ export const generateMetadata = async ({
title: page.data.title,
description: page.data.description,
openGraph: {
images: getPageImage(page).url,
images: [
{
url: getPageImage(page).url,
width: 1200,
height: 630,
alt: `${page.data.title} - Workflow DevKit`,
},
],
},
};

Expand Down
10 changes: 10 additions & 0 deletions docs/app/[lang]/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ const getMetadataBase = () => {

export const metadata: Metadata = {
metadataBase: getMetadataBase(),
openGraph: {
type: 'website',
siteName: 'Workflow DevKit',
locale: 'en_US',
},
twitter: {
card: 'summary_large_image',
site: '@vercel',
creator: '@vercel',
},
};

const Layout = async ({ children, params }: LayoutProps<'/[lang]'>) => {
Expand Down
9 changes: 8 additions & 1 deletion docs/app/[lang]/worlds/[id]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,14 @@ export async function generateMetadata({
title: `${data.world.name} World | Workflow DevKit`,
description: data.world.description,
openGraph: {
images: [`/og/worlds/${id}`],
images: [
{
url: `/og/worlds/${id}`,
width: 1200,
height: 630,
alt: `${data.world.name} World - Workflow DevKit`,
},
],
},
};
}
Expand Down
10 changes: 10 additions & 0 deletions docs/app/[lang]/worlds/compare/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ export const metadata: Metadata = {
index: false,
follow: false,
},
openGraph: {
images: [
{
url: '/og/worlds',
width: 1200,
height: 630,
alt: 'Compare World Benchmarks - Workflow DevKit',
Copy link

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alt text here uses the product name "Workflow DevKit" while the page title above is still "Compare World Benchmarks - Workflow"; for consistency with other pages and to avoid confusing metadata, consider aligning the product name between the title and this alt text (either update the title or adjust the alt string).

Suggested change
alt: 'Compare World Benchmarks - Workflow DevKit',
alt: 'Compare World Benchmarks - Workflow',

Copilot uses AI. Check for mistakes.
},
],
},
};

export default async function CompareBenchmarksPage() {
Expand Down
9 changes: 8 additions & 1 deletion docs/app/[lang]/worlds/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ export const metadata: Metadata = {
description:
'The World abstraction allows workflows to run anywhere — locally, on Vercel, or on any cloud. The runtime, queues, and persistence are modular and entirely swappable.',
openGraph: {
images: ['/og/worlds'],
images: [
{
url: '/og/worlds',
width: 1200,
height: 630,
alt: 'Worlds - Workflow DevKit',
},
],
},
};

Expand Down
Binary file modified docs/lib/og/assets/background.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/lib/og/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { readFile } from 'node:fs/promises';
import { join } from 'node:path';
import { ImageResponse } from 'next/og';

/** Standard OpenGraph image dimensions */
export const OG_IMAGE_SIZE = { width: 1200, height: 628 };
/** Standard OpenGraph image dimensions (1200x630 is the recommended size) */
export const OG_IMAGE_SIZE = { width: 1200, height: 630 };

export type OgImageOptions = {
title: string;
Expand Down
Loading