Repository navigation
docs(docs): README hero card, editor screenshot, and Codex setup - #77
Merged
Merged
Conversation
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>
|
🎉 This PR is included in version 0.5.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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.docs/ui-screenshot.jpg, a full screenshot ofclip ui, under the paragraph that describes the browser UI.~/.codex/config.tomlblock, and Codex in the list of MCP clients.Why
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.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
npxconfig, Codex lists all eight tools.timeline_showcall returns the demo timeline (16.3 s, 6 captions).initializedirectly asmakemyclip-editor0.5.1.HEAD/docs/hero.png(checked in a browser), so it switches to the card when this merges.docs/hero.pngis 677 KB, small enough to upload as the social preview (GitHub's limit is 1 MB).docs/ui-screenshot.jpgis 485 KB.pnpmchecks: Biome and the tests don't cover README.md or images.