Skip to content

Add a custom GitHub social preview image #41

Description

@kkir

Difficulty: easy

The repo still uses GitHub's default Open Graph card (usesCustomOpenGraphImage: false). Link unfurls look generic. We already have a mascot (crates/www/assets/mascot.png) and docs/images/dashboard-overview.png.

Done when

  • A 1280x640 (or GitHub's current recommended) social preview PNG lives under docs/images/ (for example docs/images/social-preview.png).
  • README or CONTRIBUTING notes how to regenerate it if the UI/mascot changes (reuse scripts/capture-readme-screenshots.mjs if that is the path, or a one-line recipe).
  • After merge, a maintainer can set Settings → General → Social preview to that file (that click is maintainer-only; the file + recipe is the contributor work).

Do not invent new product screenshots. Reuse existing brand art.

See CONTRIBUTING.md.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions