Skip to content

Add a social preview banner - #26

Merged
ChrisonSimtian merged 1 commit into
developfrom
chore/social-preview
Aug 22, 2026
Merged

Add a social preview banner#26
ChrisonSimtian merged 1 commit into
developfrom
chore/social-preview

Conversation

@ChrisonSimtian

Copy link
Copy Markdown
Contributor

GitHub was serving the auto-generated card (opengraph.githubassets.com) for this repo, while the framework has a custom upload — so a link to this repo looked unrelated to it.

Changes

  • .assets/fallout-social-preview.svg — source, adapted from the framework's.
  • .assets/fallout-social-preview.png — 1280×640, what GitHub serves.
  • .vscodeignore — keep .assets/** out of the .vsix; it's repo branding, not an extension asset (media/ holds those).

Notes

Same layout, palette and trefoil as the framework's banner. Two lines differ, because copying it verbatim would have made this repo claim to be the framework: the tagline reads "Build targets, inside your editor", and the footer is this repo's URL.

Uploading is manual — Settings → General → Social preview. GitHub has no REST API for it, so merging this doesn't change the card on its own; it only tracks the source so it can be regenerated instead of recovered from a screenshot.

Regenerate with:

rsvg-convert -w 1280 -h 640 -o .assets/fallout-social-preview.png .assets/fallout-social-preview.svg

GitHub was generating the default avatar-and-title card for this repo, so a
shared link looked nothing like the framework's. Same design, with the tagline
and footer saying what this repository actually is.

The SVG is the source and the PNG is what GitHub takes; both are tracked so the
next regeneration starts from the design rather than from a screenshot. Uploading
it is a manual step in repo settings — GitHub exposes no API for it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ChrisonSimtian ChrisonSimtian added the documentation Improvements or additions to documentation label Aug 22, 2026
@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 71003dff-47b6-4c6c-91da-7458972fdc0a

📥 Commits

Reviewing files that changed from the base of the PR and between b8f54fe and 9c93952.

⛔ Files ignored due to path filters (2)
  • .assets/fallout-social-preview.png is excluded by !**/*.png
  • .assets/fallout-social-preview.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • .vscodeignore

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


📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Updated extension packaging to exclude repository branding assets.
    • Preserved existing packaging exclusions and required Mermaid bundle inclusion.

Walkthrough

The VS Code packaging ignore list now excludes repository branding assets under .assets/**. Existing extension exclusions and the explicit Mermaid bundle inclusion remain unchanged.

Changes

Extension packaging

Layer / File(s) Summary
Branding asset exclusion
.vscodeignore
Adds comments and excludes .assets/** from the extension package. Existing packaging rules remain in place.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 9c939

This change adds social preview artwork and keeps it out of the packaged extension; it does not alter extension behavior, so no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a custom social preview banner.
Description check ✅ Passed The description accurately explains the banner files, packaging exclusion, repository-specific text, manual upload, and regeneration command.
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 0 files. (1 skipped: 1 unsupported.)
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/social-preview

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

@ChrisonSimtian
ChrisonSimtian merged commit 32bd5e9 into develop Aug 22, 2026
2 checks passed
@ChrisonSimtian
ChrisonSimtian deleted the chore/social-preview branch August 22, 2026 12:11
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