Skip to content

docs(docs): use a card as the README hero, move the screenshot down - #79

Merged
yultyyev merged 1 commit into
mainfrom
docs/readme-hero-card
Nov 16, 2026
Merged

yultyyev merged 1 commit into
mainfrom
docs/readme-hero-card

Conversation

@yultyyev

Copy link
Copy Markdown
Collaborator

Look at the hero under the badges, and at the screenshot under the browser UI paragraph in "All 19 tools".

Follows #77, which merged before these changes were pushed to it.

What

  • Replaces the square editor screenshot at the top with a 2:1 card at the same path, docs/hero.png.
    • Left: "Chat with your video editor" as the heading, a sample request and the reply, and badges for Claude, Codex, Cursor and Free.
    • Right: crops of the real editor's monitor and timeline.
  • Moves the full screenshot to docs/ui-screenshot.jpg, under the paragraph that lists what the browser UI does.

Why

  • Height: the square screenshot took a whole screen above the first paragraph. The card is half the height.
  • No repeated name: the card leaves out "MakeMyClip Editor" because the README title sits right above it. The link preview (docs/social-preview.jpg, already uploaded in Settings) keeps the name, since it shows without the README around it.
  • The screenshot still has a place: it sits next to the text that describes what's in it.
  • Same file name: npm's package page loads the hero from raw.githubusercontent.com/MakeMyClip/editor/HEAD/docs/hero.png, so it updates on merge with no release.

Release

This doesn't release: it's a docs commit, which the angular preset doesn't release on.

Checks

  • Card layout: 1600×800, 667 KB. Two font sizes (45 px heading, 24 px everything else). The heading's first letter, the bubbles and the badges sit 60 px from the left, the heading 60 px from the top, and the badges 60 px from the bottom, measured in the browser.
  • Badges: the card only names clients the README covers. Claude and Cursor were already there, and the Codex setup came in docs(docs): README hero card, editor screenshot, and Codex setup #77, tested with Codex CLI. ChatGPT waits for Test the MCP server in the ChatGPT desktop app #76.
  • Codex review skipped: this changes docs only.
  • No pnpm checks: Biome and the tests don't cover README.md or images.

The full editor screenshot is nearly square and took a whole screen at
the top of the README. Use a 2:1 card as the hero instead: "Chat with
your video editor", a sample request and reply, badges, and crops of
the editor's monitor and timeline. It keeps the docs/hero.png path, so
npm's page picks it up without a release.

The full screenshot moves under the paragraph that lists what the
browser UI does.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yultyyev
yultyyev merged commit 1bf50ec into main Nov 16, 2026
1 check passed
@yultyyev
yultyyev deleted the docs/readme-hero-card branch November 16, 2026 01:50
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 0.5.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant