Skip to content

docs: replace README screenshot with demo video#20

Merged
jevin98 merged 3 commits into
mainfrom
codex/readme-demo-video
May 15, 2026
Merged

docs: replace README screenshot with demo video#20
jevin98 merged 3 commits into
mainfrom
codex/readme-demo-video

Conversation

@jevin98

@jevin98 jevin98 commented May 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replace the README screenshot embed with a GitHub-hosted video asset in both English and Simplified Chinese README files so GitHub renders the workflow demo inline.
  • Add img/css-diff-demo.mp4, the generated CSS-Diff workflow demo video used for the uploaded asset.
  • Remove the old img/screenshot.png asset.

Why

A video better demonstrates the everyday CSS-Diff workflow than a static screenshot, including selecting two similar buttons, inspecting the diff table, filtering properties, and copying a value. Using the GitHub user-attachments asset URL keeps the demo visible in the rendered repository README.

Verification

  • Verified https://github.com/user-attachments/assets/1766e65e-fa31-4095-93d1-f247daa0e8e7 returns 200 with video/mp4
  • hyperframes lint
  • hyperframes inspect --samples 5
  • Chromium playback check for img/css-diff-demo.mp4 at 1440x900
  • pnpm exec eslint . --fix
  • pnpm compile

@jevin98 jevin98 marked this pull request as ready for review May 15, 2026 08:58
@jevin98 jevin98 changed the title [codex] Replace README screenshot with demo video docs: replace README screenshot with demo video May 15, 2026
@jevin98 jevin98 marked this pull request as draft May 15, 2026 08:58
@jevin98 jevin98 marked this pull request as ready for review May 15, 2026 08:58

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d09bd93625

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
</div>

![Screenshot](https://github.com/jevin98/css-diff-devtools/blob/main/img/screenshot.png?raw=true)
<video src="./img/css-diff-demo.mp4" controls muted loop playsinline preload="metadata" width="100%" aria-label="CSS-Diff DevTools workflow demo">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the README demo visible on GitHub

This README is primarily viewed on GitHub, but GitHub sanitizes repository README HTML and does not render a playable <video> element here; with img/screenshot.png removed in the same change, the landing page loses the inline visual demo rather than replacing it. In this context, use a GitHub-supported pattern such as a linked thumbnail/GIF or an uploaded video asset link so visitors still see or can access the workflow demo.

Useful? React with 👍 / 👎.

@jevin98

jevin98 commented May 15, 2026

Copy link
Copy Markdown
Owner Author
css-diff-demo.mp4

@jevin98 jevin98 marked this pull request as draft May 15, 2026 09:34
@jevin98 jevin98 marked this pull request as ready for review May 15, 2026 09:35
@jevin98

jevin98 commented May 15, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@jevin98 jevin98 merged commit cd3b80b into main May 15, 2026
5 of 6 checks passed
@jevin98 jevin98 deleted the codex/readme-demo-video branch May 15, 2026 09:46
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