Repository navigation
Use a crop-safe static OG image for docs link previews - #736
Draft
andrewleesteele wants to merge 2 commits into
Draft
andrewleesteele wants to merge 2 commits into
andrewleesteele wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Contributor
Author
|
@juecd it's cute, will update pr |
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
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/esand the previews look broken.This sets a single static
og:image/twitter:imagefor all docs pages viaseo.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 matcheskernel.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
docs.jsonparses as valid JSONmint devlocally (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