Skip to content

Use a crop-safe static OG image for docs link previews - #736

Draft
andrewleesteele wants to merge 2 commits into
mainfrom
hypeship/docs-og-image
Draft

andrewleesteele wants to merge 2 commits into
mainfrom
hypeship/docs-og-image

Conversation

@andrewleesteele

@andrewleesteele andrewleesteele commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Slack's link cards crop the preview image to a centered square. Mintlify's auto-generated OG image puts the logo and page title on the left, so the crop shows a sliver like EL / es and the previews look broken.

This sets a single static og:image / twitter:image for all docs pages via seo.metatags (Mintlify docs). The new 1200×630 image (images/og-image.png) is the design-provided mascot + "docs" frame. Everything sits inside the center 630×630 area, so it survives the square crop and still reads fine at the full 1.91:1 ratio on X and LinkedIn. The background color matches kernel.sh/og-image.png.

Page titles and descriptions still come through in the unfurl text. The only loss is the per-page title baked into the image.

Testing

  • Checked a simulated center-square crop of the image
  • docs.json parses as valid JSON
  • Didn't verify with mint dev locally (the preview hung during setup). Check the meta tags on the PR preview deploy, then paste a docs link into Slack after merge (Slack caches unfurls, so a previously shared URL may need a cache-bust like ?v=2)

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 30, 2026, 1:12 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@juecd

juecd commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

thoughts on this?
Frame 69023
if you feel strongly about the kernel logo being the main image, then i'd just update the word "docs" to match brand guidelines (inter light, 48px, no kerning, lowercase)

@andrewleesteele

Copy link
Copy Markdown
Contributor Author

@juecd it's cute, will update pr

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
staging — 556cee9b Deployed Oct 30, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants