Skip to content

docs(docs): README hero card, editor screenshot, and Codex setup - #77

Merged
yultyyev merged 3 commits into
mainfrom
docs/readme-hero-screenshot
Nov 16, 2026
Merged

yultyyev merged 3 commits into
mainfrom
docs/readme-hero-screenshot

Conversation

@yultyyev

@yultyyev yultyyev commented Nov 16, 2026 •

Copy link
Copy Markdown
Collaborator

Look at the hero under the badges, the screenshot under the browser UI paragraph in "All 19 tools", and "As an MCP server" in Install for the Codex setup.

What

  • Replaces the "Hero demo gif coming soon" placeholder with a 2:1 card at the same path, docs/hero.png. The card has a heading, a tagline, a sample request and reply, badges for Claude, Codex, Cursor and Free, and crops of the real editor's monitor and timeline.
  • Adds docs/ui-screenshot.jpg, a full screenshot of clip ui, under the paragraph that describes the browser UI.
  • Adds Codex setup to the MCP section: a ~/.codex/config.toml block, and Codex in the list of MCP clients.

Why

  • Hero: the placeholder showed nothing about the product. The card shows what using it looks like, in half the height of a full screenshot, and doubles as the repo's link preview. It's already uploaded in Settings → Social preview.
  • Screenshot: the real browser editor running a 16-second demo timeline (three cuts of a talking head, two B-roll shots, a title, six captions), with the playhead at 1 s so the monitor shows the composited frame. It sits next to the text that lists what's in it. It was captured 1000 px wide so the UI text stays readable at the README's 720 px.
  • Same file name for the hero: npm's package page loads the README image from raw.githubusercontent.com/MakeMyClip/editor/HEAD/docs/hero.png. A rename would break the image on npm until the next release, since this PR doesn't release.
  • Codex: the card names Codex, so the README needs to say how to set it up. ChatGPT stays off both until it's tested in the ChatGPT desktop app (Test the MCP server in the ChatGPT desktop app #76).

The demo footage was generated from three still frames, and the workspace in the screenshot is a neutral demo folder.

Release

This doesn't release: every commit is docs, which the angular preset doesn't release on.

Checks

  • Codex setup, tested with Codex CLI 0.162.1:
    • With the README's npx config, Codex lists all eight tools.
    • A timeline_show call returns the demo timeline (16.3 s, 6 captions).
    • The server also answers initialize directly as makemyclip-editor 0.5.1.
  • Branch README on GitHub: the hero loads at 1600×800, shown at 720×360. The screenshot loads at 1500×1650, shown at 720×792.
  • npm: the package page loads the hero from HEAD/docs/hero.png (checked in a browser), so it switches to the card when this merges.
  • Sizes: docs/hero.png is 677 KB, small enough to upload as the social preview (GitHub's limit is 1 MB). docs/ui-screenshot.jpg is 485 KB.
  • No conflict with docs(docs): restyle the npm downloads badge like skills.sh and drop the version badge #75: it changes the badge row; this PR changes the image below it.
  • Codex review skipped: this changes docs only.
  • No pnpm checks: Biome and the tests don't cover README.md or images.

yultyyev and others added 3 commits November 15, 2026 16:53
Replace the "screencast coming soon" placeholder with a screenshot of
`clip ui`: a 16-second demo timeline (three cuts of a talking head, two
B-roll shots, a title and six captions) with the playhead at 1 s, where
the monitor shows the composited frame.

Add docs/social-preview.jpg, a 1280x640 card for link previews built
from crops of the same screenshot. It is set in the repository's
Settings, not referenced from the README.

The sample footage was generated from three still frames; the
workspace path in the screenshot is a neutral demo folder.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex (the CLI and the IDE extension) reads MCP servers from
~/.codex/config.toml. Add the same npx server there, and name Codex in
the MCP section's list of clients.

Tested with Codex CLI 0.162.1: with this config, Codex lists all eight
tools and a timeline_show call returns the timeline.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
npm's package page rewrites the README's relative image path to
raw.githubusercontent.com/MakeMyClip/editor/HEAD/docs/hero.png, from the
README published with the last release. Renaming the file to hero.jpg
would 404 that image on npm as soon as this merges, until the next
release. Keep the old path and store the new screenshot there as a PNG.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yultyyev
yultyyev merged commit 48fc8ba into main Nov 16, 2026
1 check passed
@yultyyev yultyyev changed the title docs(docs): show the real browser editor as the README hero, add Codex setup docs(docs): README hero card, editor screenshot, and Codex setup Nov 16, 2026
@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