Skip to content

docs(assets): add GitHub social preview image variants#176

Draft
pftom wants to merge 1 commit intomainfrom
docs/social-preview-assets
Draft

docs(assets): add GitHub social preview image variants#176
pftom wants to merge 1 commit intomainfrom
docs/social-preview-assets

Conversation

@pftom
Copy link
Copy Markdown
Contributor

@pftom pftom commented Apr 30, 2026

Summary

Add three candidate social preview PNGs under docs/assets/ for use as the repository's GitHub social preview image (Settings β†’ General β†’ Social preview).

  • docs/assets/social-preview-cropped.png
  • docs/assets/social-preview-padded.png
  • docs/assets/social-preview-stretched.png

These are not referenced from any README; they're intended only as upload candidates for the repo's social card.

Test plan

  • Decide which variant (cropped / padded / stretched) renders best at GitHub's 1280Γ—640 social card slot.
  • Upload the chosen variant under repo Settings β†’ General β†’ Social preview.
  • (Optional) Drop the unused two variants in a follow-up cleanup commit.

Made with Cursor

Add three candidate social preview PNGs (cropped, padded, stretched) under
docs/assets/ for use as the repository's GitHub social preview.

Made-with: Cursor
@lefarcen lefarcen self-requested a review April 30, 2026 14:12
Copy link
Copy Markdown
Contributor

@lefarcen lefarcen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @pftom, clean asset addition β€” all three variants match GitHub's 1280Γ—640 social preview spec, file sizes reasonable (409-484KB). πŸ‘

Code review (Lens A β€” asset correctness): PNG format βœ“, dimensions βœ“, no embedded code/exif concerns for static display.

Reasoning review (Lens B β€” process completeness): A few non-blocking observations:

  1. Test plan mentions manual upload workflow (pick variant β†’ Settings β†’ upload) but doesn't specify:

    • Who decides (design lead? maintainer consensus?)
    • Decision criteria beyond "renders best" (brand alignment? text legibility at small previews? mobile vs desktop preview differences?)
    • Timeline (before/after next release? marketing push?)
  2. No documentation commit planned β€” Once a variant is chosen, consider adding a brief note somewhere (e.g., docs/assets/README.md or root README.md Social section) noting:

    • Which variant was selected and why
    • Original source/design file location (if reproducible)
    • Update process (when/how to regenerate if branding changes)
  3. Alternative not discussed: Why three candidates instead of one confident choice upfront? If it's A/B testing for social engagement, tracking plan would help (e.g., switch after 1 week, compare GitHub stars/traffic). If it's just "let's see," could narrow to 1-2.

  4. Cleanup step is optional β€” but leaving unused 2 variants in docs/assets/ forever will confuse future contributors ("which one is live?"). Consider either:

    • Moving unused variants to a candidates/ subfolder, or
    • Committing only the chosen one (delete others pre-merge)

All P3 β€” asset files themselves are good. Merge as-is if you want to decide the variant post-commit; just close the loop with docs/cleanup afterward. πŸš€

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