docs(assets): add GitHub social preview image variants#176
docs(assets): add GitHub social preview image variants#176
Conversation
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
left a comment
There was a problem hiding this comment.
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:
-
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?)
-
No documentation commit planned β Once a variant is chosen, consider adding a brief note somewhere (e.g.,
docs/assets/README.mdor rootREADME.mdSocial section) noting:- Which variant was selected and why
- Original source/design file location (if reproducible)
- Update process (when/how to regenerate if branding changes)
-
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.
-
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)
- Moving unused variants to a
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. π
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.pngdocs/assets/social-preview-padded.pngdocs/assets/social-preview-stretched.pngThese are not referenced from any README; they're intended only as upload candidates for the repo's social card.
Test plan
Made with Cursor