chore: switch OG image to Mintlify auto-generated template#6
Merged
Conversation
Replace the static /assets/docs-banner.png OG image with Mintlify's per-page generated previews using `thumbnails.background` so each shared link renders the page title and description over a branded template instead of one generic banner. Note: requires a 1200x630 template asset at /assets/og-template.png with no baked-in text (Mintlify overlays logo + title + description). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
PR SummaryLow Risk Overview Updates Reviewed by Cursor Bugbot for commit fa8b7a7. Bugbot is set up for automated code reviews on this repo. Configure here. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
1200x630 PNG rendered from the existing /assets/header.svg rings pattern with the Sei wave symbol stripped (Mintlify overlays its own logo + title + description on top). Dark center leaves clean space for the overlay; rings frame the edges. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Initial render had rings at full saturation; Mintlify's OG generator places the page title bottom-left, where the bright rings made the title illegible. Dropping rings to ~25% opacity over solid black keeps the visual branding while leaving the title area readable. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The OG template background is dark (black with subtle red rings), so light-mode text rendering (dark text on dark bg) was illegible. Switch thumbnails.appearance to "dark" so Mintlify renders the title, division eyebrow, and description in light colors for readable contrast on the dark template. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
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
og:image(/assets/docs-banner.png) fromseo.metatagsso Mintlify's per-page social card generator takes over.thumbnails.background: /assets/og-template.pngso each card renders with our branded backdrop.thumbnails.appearance: darkso the title/description render in light text for readable contrast on the dark template.assets/og-template.png— 1200×630, derived from the existingassets/header.svgrings pattern, Sei wave symbol stripped, rings dimmed to ~25% opacity over black so they read as a watermark instead of dominating the title area.Before: every shared URL previewed as the same static "Sei Documentation" banner. After:
/node/node-operatorspreviews as "Sei Node Operations Guide" with its page description over the branded rings backdrop. Each page gets its own card.Verified on the preview deploy
<meta og:image>resolves to Mintlify's OG generator with our template passed as thebackgroundparameter./node/node-operatorsshows division eyebrow ("Node Operations"), page title, description, and the dimmed rings backdrop — all legible.Cache note
Telegram/Slack/Discord aggressively cache OG images (typically days). Already-shared links will keep showing the old banner — append a throwaway query param (
?v=2) when re-sharing to force a refresh.Test plan
https://docs.sei.io/node/node-operators?v=2into Slack/Telegram and verify the preview shows the per-page title rather than the static banner.🤖 Generated with Claude Code