Skip to content

docs: 🎨 Keep the social preview inside the area that GitHub's cards show - #223

Merged
ShisatoYano merged 1 commit into
mainfrom
docs/social-preview-safe-area
Nov 8, 2026
Merged

ShisatoYano merged 1 commit into
mainfrom
docs/social-preview-safe-area

Conversation

@ShisatoYano

@ShisatoYano ShisatoYano commented Nov 8, 2026 •

Copy link
Copy Markdown
Owner

Problem

GitHub's repository cards (for example in lists of starred repositories) show the 1280×640 social preview at about 2.6:1. They crop about 80 px at the top and the bottom, and this cut off the title.

Change

doc/social_preview.py keeps everything between y = 100 and 540 px:

  • The title and the subtitle.
  • One row of the first four demos of the README grid, larger than before: EKF vs UKF vs PF, MPPI, Hybrid A*, NDT.

The top and bottom margins are empty, so the cropped cards and the uncropped 2:1 views (LinkedIn, X) both show the whole content.

Check

  • Drew the image and marked a 2.64:1 center crop on it: the title, the labels and all four demos are inside.
  • The book builds with -W without warnings, and the image is in the output (about 135 KB).

After merge (maintainer)

Download https://shisatoyano.github.io/AutonomousVehicleControlBeginnersGuide/social_preview.png again and upload it in Settings → General → Social preview.

🤖 Generated with Claude Code

GitHub's repository cards show the 2:1 image at about 2.6:1 and crop
its top and bottom, which cut off the title. The title and a single row
of four larger demos now stay in the middle band that every card keeps.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ShisatoYano ShisatoYano added the documentation Improvements or additions to documentation label Nov 8, 2026
@ShisatoYano ShisatoYano self-assigned this Nov 8, 2026
@ShisatoYano
ShisatoYano merged commit 535d259 into main Nov 8, 2026
5 checks passed
@ShisatoYano
ShisatoYano deleted the docs/social-preview-safe-area branch November 8, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant