docs: say what each client does instead of "run the demo" - #87
Merged
Conversation
"Run the X Live Runner demo" repeats the command the reader just typed. Lead with the verb and name the outcome, so --help answers what is about to happen. Wording follows each app: tiles stylizes, api-proxy saves the bytes it gets back. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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.
--helpopened with "Run the X Live Runner demo", which repeats the command the reader just typed and says nothing about what happens next.This also settles a split that had grown quietly:
realtime-transcriptionandvllmalready led with the verb ("Stream audio to a Whisper Live Runner over WebSocket", "Chat with a vLLM Live Runner using the stock OpenAI library"), while the other four used the formula. Now every description leads with what the command does and ends on "Live Runner".Wording follows each app rather than a template:
tiles/runner.pysays it "stylizes" a tile, andapi-proxy's client ends inout_path.write_bytes(image), so it saves rather than prints."proxied" drops out of echo's line. It is true and worth knowing, but it describes the architecture rather than the command, and the READMEs already cover it.
Strings only, no behaviour change. pre-commit is clean; black reflowed the api-proxy line since it no longer fits on one.