Skip to content

Voice sdk restructure#210

Merged
ArchieMcM234 merged 7 commits intomainfrom
voice-sdk-restructure
Feb 27, 2026
Merged

Voice sdk restructure#210
ArchieMcM234 merged 7 commits intomainfrom
voice-sdk-restructure

Conversation

@ArchieMcM234
Copy link
Contributor

Note: This PR is stacked on top of deprecate-flow-integrations. Which could/should be merged first.

Summary

Refactors and expands the Voice SDK documentation page with:

  • Reorganized content structure
  • New code examples (quickstart, configuration, event handling, speaker focus, etc.)
  • 10 new Python snippet files for cleaner code embedding

Future consideration

The Voice SDK docs may eventually move to live alongside the SDK repo (like other SDK docs), but
this provides a solid foundation for the integrations pages in the meantime.

@vercel
Copy link

vercel bot commented Feb 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 27, 2026 10:55am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures the Voice Agents documentation by introducing a dedicated Voice SDK page with embedded Python snippets, and updating navigation to highlight the new structure.

Changes:

  • Adds a new Voice SDK documentation page with reorganized explanations and many embedded Python examples.
  • Updates the Voice Agents sidebar to point to the new Voice SDK page (and removes the previous “Features” entry).
  • Reworks the Voice Agents overview page to emphasize integrations with LinkCard-based navigation.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
sidebars.ts Reorders the voiceAgentsSidebar placement in the top-level docs sidebar list.
docs/voice-agents/sidebar.ts Updates Voice Agents nav items to include Overview + Voice SDK (removes Flow sidebar inclusion).
docs/voice-agents/overview.mdx Replaces prior Voice SDK-focused overview with an integrations-first overview using LinkCards.
docs/voice-agents/voice-sdk.mdx New, comprehensive Voice SDK guide with sections on events/segments, presets, configuration, diarization, and serialization.
docs/voice-agents/features.mdx Removes the old “Features” page content.
docs/voice-agents/assets/*.py Adds multiple new Python snippet files used for embedding into the new Voice SDK page; adjusts custom-config.py.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


# Voice SDK overview
The Voice SDK builds on our Realtime API to provide additional features optimized for conversational AI, using Python:
Our integration partners can be the quickest way to get a production voice agent up and running.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is quite vague and feels a little disconnected. Given it's the introduction, it'd be better to be more clear - add two bullet points for the two different ways, and add clarity as to how they are different.

E.g. something like:

There are two ways to build voice agents using Speechmatics:

  • Integration partners (LiveKit, Pipecat and VAPI) - the fastest path to a production voice agent.
  • Voice SDK - direct access for custom pipelines or working outside of supported integration platforms.

Copy link
Contributor

@LArmstrongDev LArmstrongDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick review from me - not able to review in detail (e.g. code snippets) due to other priorities, but have added some comments.

ArchieMcM234 and others added 2 commits February 27, 2026 09:59
american english typo

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
typo

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ArchieMcM234 ArchieMcM234 merged commit 6210d2a into main Feb 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants