Add basic Twilio integration docs pointing to GitHub integration - #295
Add basic Twilio integration docs pointing to GitHub integration#295J-Jaywalker wants to merge 8 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
petemomo
left a comment
petemomo
left a comment
There was a problem hiding this comment.
Reviewed against the docs style guide, terminology, and product-architecture. Strong how-to overall — clear flow, a Mermaid diagram with a prose equivalent, language tabs, and a solid troubleshooting table with real Twilio error codes. Comments inline (one blocking: the missing Twilio logo).
Optional nits (non-blocking):
- μ-law / mulaw: the diagram says "μ-law", the prose says "mulaw" — pick one.
- "per-speaker" vs "per-channel": this uses channel diarization (inbound/outbound channels), so "per-channel" is more precise than "per-speaker".
- Trivia: double space in "hands that audio to Speechmatics with"; the banner/console output blocks have no language tag (the style guide wants one —
textis fine); and the frontmatterdescriptionopens "Learn how to…" where the guide prefers an imperative.
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Open `.env` in your editor and the environment variables. The proxy won't run if any are missing. |
There was a problem hiding this comment.
Missing a verb here — should be something like: "Open .env in your editor and set the environment variables."
There was a problem hiding this comment.
added missing verb, "set"
|
|
||
| This guide walks you through a small proxy that takes that audio stream and feeds it into Speechmatics Realtime, printing per-speaker transcripts to your console as the call unfolds. The [reference repo](https://github.com/speechmatics/speechmatics-twilio-integration) ships the same proxy in two languages — [Python](https://github.com/speechmatics/speechmatics-twilio-integration/tree/main/python) and [Node.js](https://github.com/speechmatics/speechmatics-twilio-integration/tree/main/js) — so pick whichever fits your team. | ||
|
|
||
| ## How it works |
There was a problem hiding this comment.
Heading nit: the style guide lists pronoun-dependent headings ("How this works") as invalid — name the subject, e.g. "How the integration works" or "How the proxy works".
There was a problem hiding this comment.
changed to "how the proxy works"
|
@J-Jaywalker Process note (not blocking): this PR and #291 (Zapier) both edit |
3 participants
Adds a new integration guide walking developers through the Twilio ↔ Speechmatics reference proxy: what Twilio is, what the integration does, and how to get a bridged two-party call transcribed on their own machine.
docs/integrations-and-sdks/twilio.mdx— explains Media Streams and the audio-fork concept, includes a Mermaid architecture diagram, an interactive checkbox prerequisites list, and Python / Node.js install-and-run steps in language tabs. Ends with a troubleshooting table covering the four errors most users will hit (missing env vars, wrong number, trial-mode unverified caller, and "application error has occurred").docs/integrations-and-sdks/sidebar.ts— adds a Twilio entry after Vapi.docs/integrations-and-sdks/index.mdx— adds a new Telephony integrations section with a Twilio LinkCard.