docs: rework the README around the talking-tab quick start - #122
Merged
Conversation
The what-is-it paragraph becomes the product vision; the quick start gives the agent a voice through a browser tab over env-app's callback channel (validated end to end against a local build); how-it-works widens the diagram and leads with the techniques most runtimes don't use; the benchmark charts gain published-figure and assistant-class markers; acknowledgements and the license section go, contact arrives. The docs quickstart follows the README. The quick start needs the next npm release: published 0.10.0 predates appTool/appTools.
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.
The what-is-it paragraph becomes the product vision. The quick start gives the agent a voice: its only tool lives in a browser tab, registered over env-app's outbound WebSocket channel, answered with the Web Speech API — validated end to end against a local build of the server and SDK (the published npm packages gain appTool/appTools in the next release, which this quick start depends on). How-it-works widens the diagram and leads with the techniques most runtimes don't use: sealed Wasm loops, the write-ahead journal, bounded streaming, observability as the data model. The benchmark charts gain published-figure (°) and assistant-class (†) markers; a full remeasured chart set lands separately with the new bench subjects. Acknowledgements and the license section go; a contact section arrives. The docs quickstart follows the README.