Repository navigation
docs(bidi): update python readme information for bidi - #4866
Conversation
|
Issue: The PR description states "The root README links to the bidi docs," but the diff only touches Suggestion: Either include the root README link change in this PR, or update the description to match the actual scope so reviewers/changelog aren't misled. Minor, non-blocking. (Also noting the "Human Overview" section is still the template HTML comment — per the PR template / AI usage policy a human should add a short overview in their own words.) |
|
Assessment: Approve Clean, accurate rewrite of the bidi README section. I verified every technical claim against the source and Verification details
Minor, non-blocking notes left inline: description/scope mismatch (root README link not in diff), empty "Human Overview", and loss of the config-options pointer. Nice improvement — the new section is noticeably easier to follow than the old one. |
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Suggestion (non-blocking, re: removed "Configuration Options" block): Trimming it makes the section much cleaner, but it also removes the only in-README pointer to the knobs people reach for early — custom |
Human Overview
Description
The bidi section of
strands-py/README.mdwas out of date. Bidi graduated tostrands.bidi(#4707), but the experimental warning stayed. The example'sstrands_tools.stopno longer ends a bidi conversation since cancellation moved toagent.cancel()(#4664). The install commands also only covered Nova Sonic. The section now has per-provider install commands, a minimal example, and a link to the quickstart. The root README links to the bidi docs.Related Issues
N/A
Documentation PR
N/A. This PR is the documentation change.
Type of Change
Documentation update
Testing
Ran the example's setup on Python 3.12: imports resolve, the agent constructs, and
agent.cancel()setscancel_signal. Checked the extras againstpyproject.toml. No live voice session was run.hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.