docs(readme): rebuild for clarity + add launch assets#108
Merged
Conversation
Rewrite the README around a cognitive funnel: a one-line value prop,
hero GIF, quickstart, a "why not tmux/expect/asciinema/Playwright?"
comparison table, an honest two-backend "how it works", the origin
story, and a condensed command surface.
Add the supporting launch assets:
- assets/hero.gif + assets/hero.tape (VHS source for the hero demo)
- assets/social-preview.{html,png} + render-social-preview.mjs
(HTML/CSS -> Playwright screenshot -> 1200x630 OG/social card)
- assets/social-preview-spec.md
Pin vhs/ffmpeg/jq in mise so the assets are reproducible, and
alphabetize the [tools] list.
Change-Id: I997dc0f25eb33ea8fc8aec01c0d85142702ca94a
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Thomas Kosiewski <tk@coder.com>
ThomasK33
force-pushed
the
docs/readme-launch-polish
branch
from
1793b21 to
e70d0fe
Compare
ffmpeg resolves through mise's conda backend, which can't be cross-locked for linux-x64 from a macOS host (the conda solver has no __glibc virtual package for a non-host target), so `mise lock` only captured macOS/Windows URLs and `mise install --locked` aborted on every Linux CI job: ERROR Failed to install conda:ffmpeg@8.1.1: No lockfile URL found for ffmpeg@8.1.1 on platform linux-x64 (--locked mode) ffmpeg is already declared task-scoped under the demo:agent-uses-agent-tty* tasks, where it's actually used and lockable — it never belonged in the always-installed top-level [tools]. vhs/jq stay (aqua backend locks every platform). Note the constraint in hero.tape's optional conversion path. Also run oxfmt on the README + new assets to satisfy format-check. Change-Id: Ifc60f827cec3cdd33e3ed7ccb3e4cab93e0b83eb Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Thomas Kosiewski <tk@coder.com>
Review feedback: the block cursor (▋) read as too heavy. Replace it with a low green underscore (`_`) plus a small gap, and re-render the 1200x630 card. Change-Id: I1ea6a362c5117a03a8a21ccef5b12c9b73ba9c7d Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Thomas Kosiewski <tk@coder.com>
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.
What
Rebuilds the README to be immediately graspable and adds the supporting visual/launch assets.
README
AGENT_TTY_HOME(documented as optional, defaults to~/.agent-tty) instead of repeating--home.libghostty-vtnative VT engine +ghostty-webreference renderer).claudecode.nvimTUI bug reports → reviewable evidence loop).Assets
assets/hero.gif+assets/hero.tape— the hero demo and its VHS source.assets/social-preview.{html,png}+assets/render-social-preview.mjs— HTML/CSS → Playwright screenshot → crisp 1200×630 OG/social card.assets/social-preview-spec.md— the card spec.Tooling
vhs/ffmpeg/jqinmise.tomlso the assets are reproducible, and alphabetize the[tools]list.Notes
🤖 Generated with Claude Code