fix(docs): improve OpenGraph metadata for better social sharing #920
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update image dimensions from 1200x628 to recommended 1200x630 - Add global Twitter card and OG metadata to root layout - Include width, height, and alt attributes on all OG images - Add missing OG image to worlds compare page Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 9d75aa1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express Stream Benchmarks (includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests🌍 Community Worlds (161 failed)mongodb (40 failed):
redis (40 failed):
starter (41 failed):
turso (40 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines the documentation site's OpenGraph/Twitter metadata to improve social sharing previews and accessibility.
Changes:
- Updated the shared OG image dimensions to the recommended 1200x630 and ensured the OG image generator uses the new size.
- Added global OpenGraph and Twitter card metadata at the root
[lang]layout level. - Normalized per-page
openGraph.imagesdefinitions to includeurl,width,height, andaltacross home, docs, and worlds pages, and added an OG image for the worlds compare page.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/lib/og/index.tsx | Updates the standard OG image size to 1200x630 and keeps the OG image generator consistent with the new dimensions. |
| docs/lib/og/assets/background.png | Adds a new OG background image asset matching the updated dimensions. |
| docs/app/[lang]/worlds/page.tsx | Switches openGraph.images to an object form with explicit size and alt text for the Worlds listing page. |
| docs/app/[lang]/worlds/compare/page.tsx | Adds missing openGraph.images metadata for the Worlds benchmark compare page, including dimensions and alt text. |
| docs/app/[lang]/worlds/[id]/page.tsx | Normalizes per-world openGraph.images to an object with dimensions and descriptive alt text. |
| docs/app/[lang]/layout.tsx | Introduces global OpenGraph site metadata and Twitter card configuration at the root layout level. |
| docs/app/[lang]/docs/[[...slug]]/page.tsx | Converts dynamic docs pages’ OG image metadata to the object form with width/height/alt. |
| docs/app/[lang]/(home)/page.tsx | Updates the home page OG metadata to include explicit image dimensions and alt text. |
| .changeset/og-metadata-improvements.md | Records a patch-level changeset summarizing the OG/Twitter metadata improvements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| url: '/og/worlds', | ||
| width: 1200, | ||
| height: 630, | ||
| alt: 'Compare World Benchmarks - Workflow DevKit', |
There was a problem hiding this comment.
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', |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
summary_large_image) and OG metadata (siteName,locale) to root layoutwidth,height, andaltattributes on all OG images for better accessibilityTest plan
🤖 Generated with Claude Code