docs: Correct continuous mode disclaimer to match actual behavior#256
Open
untemps wants to merge 1 commit into
Open
docs: Correct continuous mode disclaimer to match actual behavior#256untemps wants to merge 1 commit into
untemps wants to merge 1 commit into
Conversation
…behavior The disclaimer claimed continuous mode was for "real-time transcription and always-on voice command use cases". Both are false: useVocal never enables interimResults (a single aggregated transcript is delivered via onResult at session end, not in real time) and command matching is gated off in continuous mode. Reword to describe the real behavior and note that commands are not evaluated, matching the Vocal component API table. Closes #248 Co-Authored-By: Claude Opus 4.8 (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
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.
Summary
The README Disclaimer claimed continuous mode is for "real-time transcription and always-on voice command use cases." Both claims contradict the actual behavior and the README's own API table. This reword describes what continuous mode really does and drops the false framing.
Changes
README.md(Disclaimer): replace the "real-time transcription and always-on voice command use cases" sentence with an accurate description — continuous mode keeps the recognition session open across speech segments and delivers a single, aggregated transcript throughonResultwhen the session ends (stopped by a second click or bysilenceTimeout), and commands are not evaluated in continuous mode. Keeps the pointer to theVocalcomponent API table.Why the old wording was wrong
useVocalbuilds the instance withoutinterimResults(src/hooks/useVocal.ts:43);@untemps/vocalemits a single aggregated event just beforeend, soonResultfires once with the full session transcript — not incrementally.src/components/Vocal.tsx:251,if (!continuousRef.current)). The API table (README.md:278) already states commands are not evaluated in continuous mode.The new wording reuses the API table's exact verbs so the Disclaimer and the table no longer contradict each other.
Test plan
yarn typecheck— passesyarn lint— passesyarn build— passesyarn test:ci— 189/189 passingVocalcomponent API table.Closes #248