Skip to content

docs(readme): replace the workflow GIF with a theme-aware cluster hero - #48

Merged
Railly merged 1 commit into
mainfrom
railly/readme-hero
Nov 7, 2026
Merged

Railly merged 1 commit into
mainfrom
railly/readme-hero

Conversation

@Railly

@Railly Railly commented Nov 7, 2026

Copy link
Copy Markdown
Member

Problem

The README image is a GIF of terminal output that uses the removed --repo syntax, and it does not show Linear support or the dashboard.

Changes

  • Replace it with a hero image: the issue-graph name and one-line description beside real root-cause clusters from the vercel-labs/portless capture used on the landing page, in Geist colors
  • Serve light and dark versions through <picture> so GitHub shows the one that matches the reader's theme
  • Add readme-hero-light.png and readme-hero-dark.png (2400x1200) to apps/docs/public
  • Keep the old GIF and PNG in apps/docs/public, because READMEs of earlier npm versions still link to them
  • Update the README media test

The images load from issue-graph.dev, so they appear in the README once the docs site deploys from main.

Visual proof

README hero, dark theme

README hero, light theme

The GIF showed the removed --repo syntax. Keep the old files in public/ so READMEs of earlier npm versions still load them.
@vercel

vercel Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
issue-graph Ready Ready Preview, v0 Nov 7, 2026 7:11pm UTC

@Railly
Railly merged commit 9e7a416 into main Nov 7, 2026
12 checks passed
@Railly
Railly deleted the railly/readme-hero branch November 7, 2026 19:15

This branch was successfully deployed

1 active deployment
Preview — 58adfa42 Deployed Nov 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant