docs: show the demo at the top of the README - #36
Merged
Merged
Conversation
97s of recording at 3×, so it reads in half a minute: npx installs the skill, then an agent is asked to set the repo up — once in Action mode, once in App mode, ending on the GitHub App page. GIF, not MP4, for the inline embed. GitHub renders video uploaded through the web UI but not an MP4 referenced from a repo path in markdown, so an `<img>` to a GIF is the only version that actually plays for a reader. The MP4 is committed too and linked underneath for anyone who wants full speed and full fidelity. 900px at 12fps, 128 colours: 2.7 MB, and the terminal text stays legible at that width — checked, not assumed. 720px got it to 1.8 MB but softened the smaller lines, which is the whole content here. The caption says it is 3×. A sped-up demo that does not admit it sets a first impression the product cannot meet. docs/ stays out of the npm tarball — `files` is bin/, skills/, NOTICE — so this adds nothing to install size.
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
1 participant
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.
97s of recording at 3×, so it reads in half a minute:
npxinstalls the skill, then an agent is asked to set the repo up — once in Action mode, once in App mode, ending on the GitHub App page.It opens on the language picker, which is where the four-language support shows itself:
GIF for the embed, MP4 alongside
GitHub renders video uploaded through the web UI, but not an MP4 referenced from a repo path in markdown — it renders as a dead link. So the inline embed is an
<img>to a GIF, which is the only version that actually plays for a reader landing on the repo. The MP4 is committed too and linked underneath for full speed and full fidelity.Sizing
Plus
docs/demo.mp4at 896 KB.docs/stays out of the npm tarball —filesisbin/,skills/,NOTICE— so this adds nothing to install size. Verified againstnpm pack --dry-run.The caption says 3×
A sped-up demo that doesn't admit it sets a first impression the product can't meet. One line of
<sub>costs nothing.411 tests still passing; no code touched.