Skip to content

docs: add open graph share image - #1373

Merged
jdx merged 1 commit into
mainfrom
claude/og-image
Sep 3, 2026
Merged

docs: add open graph share image#1373
jdx merged 1 commit into
mainfrom
claude/og-image

Conversation

@jdx

@jdx jdx commented Sep 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add a 1200x630 Open Graph share card at docs/public/og.png, rendered from the site's own logo, fonts, and tagline
  • Point og:image / twitter:image at it, add og:image:width / og:image:height, and switch twitter:card to summary_large_image

Preview

og image

🤖 Generated with Claude Code

AI-assisted — Tool: Claude Code; model: anthropic/claude-fable-5-1; version: unavailable.


Note

Low Risk
Docs-only head metadata and a static asset; no runtime or application logic changes.

Overview
Adds a dedicated 1200×630 share card (og.png) for link previews and wires the docs site to use it instead of the square app icon.

In docs/.vitepress/config.mts, og:image and twitter:image now point at https://usage.jdx.dev/og.png, with og:image:width / og:image:height set to 1200 and 630. twitter:card is switched from summary to summary_large_image so Twitter/X shows the wide preview.

Reviewed by Cursor Bugbot for commit c4db848. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Style
    • Updated social sharing previews to use a dedicated image.
    • Added image dimensions for Open Graph previews.
    • Changed Twitter previews to display a larger image format.

Replace the 512px favicon used as the share preview with a 1200x630 card
rendered from the site's own logo, fonts, and tagline, and switch the
twitter card to summary_large_image.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Team

Run ID: 51855a0d-a5a9-4e66-b96b-377de8229970

📥 Commits

Reviewing files that changed from the base of the PR and between 4cdd785 and c4db848.

⛔ Files ignored due to path filters (1)
  • docs/public/og.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/.vitepress/config.mts

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The VitePress head configuration now uses og.png for OpenGraph and Twitter previews. It adds OpenGraph dimensions and changes the Twitter card type to summary_large_image.

Changes

Social preview metadata

Layer / File(s) Summary
Update social preview tags
docs/.vitepress/config.mts
The metadata uses og.png, adds 1200×630 OpenGraph dimensions, and changes the Twitter card type.
Estimated code review effort: 1 (Trivial) ~3 minutes

Merge Risk: ⚪ Minimal · up to c4db8

Social sharing metadata now uses the dedicated 1200×630 preview image with matching dimensions and a large-image Twitter card. No current merge-readiness risk remains.

Poem

A rabbit checks the social card bright
New preview pixels hop into sight
OpenGraph wears its proper frame
Twitter grows a larger name
The docs now shine in carrot light

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding an Open Graph share image and related metadata updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@jdx
jdx enabled auto-merge (squash) September 3, 2026 18:12
@jdx
jdx merged commit d15a69c into main Sep 3, 2026
11 checks passed
@jdx
jdx deleted the claude/og-image branch September 3, 2026 18:20
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.

1 participant