Skip to content

chore: update GitHub repo social preview image to new brand #197

@vmorps

Description

@vmorps

Overview

The GitHub repository's Social Preview image — the image that appears when the repo URL is shared on LinkedIn, X/Twitter, Slack, etc. — is still the old brand. The new opentdf-social.png has been designed and added to the repo in PR #191, but updating the social preview requires admin access to repository Settings, which must be done manually.

Why this matters

When someone shares https://github.com/opentdf/docs (or https://github.com/opentdf) on social media or in a Slack/Teams message, the social preview card is the first visual impression of the project. Keeping it on the old brand undermines the redesign work.

Who can do this

Requires Admin access to the opentdf/docs (or opentdf org) repository settings. Maintainer-level access is not sufficient.

Instructions

⚠️ Complete this after PR #191 is merged so the image is live on main.

  1. Download the new social image:

  2. Go to the repository settings:

  3. Scroll down to the Social preview section.

  4. Click EditUpload an image.

  5. Upload the opentdf-social.png file downloaded in step 1.

  6. Click Save changes.

Image details

  • Dimensions: 1200 × 630 px (optimal for all platforms)
  • Design: Dark background (#0a0c10), cyan-to-purple gradient headline, code window, opentdf.io URL, TDF Specification and Core Foundational Services pills
  • File: static/img/opentdf-social.png in this repo

Validation

After uploading, paste the repo URL into these validators to confirm the preview is correct:

Related

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions