Skip to content

Docs: add the repository social preview card - #39

Merged
SandObserver merged 1 commit into
mainfrom
docs/add-social-preview-card
Sep 7, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/add-social-preview-card

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Add .github/social-card.png, the 1280x640 repository social preview, showing the built Introduction page inside the landing page's bezel.
  • Sits in .github/ rather than public/, so it is versioned without being published on the site, and outside check-dist's scanned roots.

The headline is the repository's own GitHub description. GitHub reads its social preview from repository settings, so the image still has to be uploaded there once.

Testing
All green: npm run build and npm run check both pass. The card was rendered at 400px, the width a phone gives a link preview, to confirm the wordmark, headline and repository path stay legible.

Checklist

  • npm run build and npm run check both pass.
  • Product UI is shown by running or capturing it, never recreated in CSS.
  • Any new preview or screenshot carries no private hostnames or real data.
  • Visual changes verified in both colour schemes and both docs themes.
  • Links to the app repo still resolve.

The image is versioned here; GitHub reads its social preview from repository
settings, so it still has to be uploaded there once.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Sep 7, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying stackyard-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 01aee49
Status: ✅  Deploy successful!
Preview URL: https://28462bc0.stackyard-docs.pages.dev
Branch Preview URL: https://docs-add-social-preview-card.stackyard-docs.pages.dev

View logs

@SandObserver
SandObserver merged commit 1f407e2 into main Sep 7, 2026
2 checks passed
@SandObserver
SandObserver deleted the docs/add-social-preview-card branch September 7, 2026 00:04
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