Skip to content

docs: Correct continuous mode disclaimer to match actual behavior#256

Open
untemps wants to merge 1 commit into
betafrom
docs/248-continuous-mode-disclaimer
Open

docs: Correct continuous mode disclaimer to match actual behavior#256
untemps wants to merge 1 commit into
betafrom
docs/248-continuous-mode-disclaimer

Conversation

@untemps

@untemps untemps commented Jun 26, 2026

Copy link
Copy Markdown
Owner

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 through onResult when the session ends (stopped by a second click or by silenceTimeout), and commands are not evaluated in continuous mode. Keeps the pointer to the Vocal component API table.

Why the old wording was wrong

  • No real-time transcription: useVocal builds the instance without interimResults (src/hooks/useVocal.ts:43); @untemps/vocal emits a single aggregated event just before end, so onResult fires once with the full session transcript — not incrementally.
  • No always-on voice commands: command matching is gated off in continuous mode (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 — passes
  • yarn lint — passes
  • yarn build — passes
  • yarn test:ci — 189/189 passing
  • Read the rendered Disclaimer and confirm it no longer mentions real-time transcription or always-on commands, and matches the Vocal component API table.

Closes #248

…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant