Skip to content

docs: add Telnyx integration page#106

Merged
cshape merged 8 commits into
mainfrom
docs/telnyx-integration
Jul 23, 2026
Merged

docs: add Telnyx integration page#106
cshape merged 8 commits into
mainfrom
docs/telnyx-integration

Conversation

@cshape

@cshape cshape commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a Telnyx page to the Integrations section (requested by Telnyx — they now host Fish Audio as a curated TTS provider with in-call playback).

  • New developer-guide/integrations/telnyx.mdx following the existing integration-page conventions: what Telnyx is (their own site wording), where Fish Audio fits, the curated-voice policy and FishAudio.<Model>.<VoiceId> format, WebSocket streaming + REST examples, and links to Telnyx's docs.
  • Telnyx logo mark as the page icon (images/telnyx-logo.svg, brand green #00E3AA sampled from their favicon — works in light and dark mode).
  • Drive-by fix: the Pipecat sidebar icon was invisible in dark mode (black PNG on transparent). Wrapped it in an SVG that inverts to white under prefers-color-scheme: dark.

Testing

Both code examples were run against the live Telnyx API with a Fish voice and produce valid MP3 audio.

Also verified: page renders correctly in mint dev (light + dark), nav entry added to docs.json, mint broken-links reports no issues outside the pre-existing temp/ templates.

Note: no speak-mintlify-hash / AudioTranscript block yet — left for the audio-generation tooling's next pass.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@cshape, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a17154c1-6b5f-4b14-a549-3c057303948a

📥 Commits

Reviewing files that changed from the base of the PR and between b24f88d and 002c4f5.

📒 Files selected for processing (2)
  • api-reference/openapi.json
  • developer-guide/integrations/telnyx.mdx
📝 Walkthrough

Walkthrough

Adds a Telnyx integration page covering setup, voices, WebSocket streaming, REST synthesis, and reference links. The page is added to integrations navigation, and the Pipecat icon reference changes from PNG to SVG.

Changes

Telnyx integration documentation

Layer / File(s) Summary
Telnyx integration overview
developer-guide/integrations/telnyx.mdx
Adds page metadata, prerequisites, Telnyx/Fish Audio relationship details, and curated voice naming guidance.
Telnyx API examples
developer-guide/integrations/telnyx.mdx
Documents WebSocket MP3 streaming, REST synthesis, response formats, and provider resources.
Integration navigation and metadata
docs.json, developer-guide/integrations/pipecat.mdx
Adds Telnyx to the Integrations navigation and changes the Pipecat icon asset from PNG to SVG.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • fishaudio/docs#30: Adds an integration page through the same docs.json Integrations navigation group.
  • fishaudio/docs#83: Restructures and introduces the Integrations navigation grouping.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding a Telnyx integration documentation page.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/telnyx-integration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mintlify

mintlify Bot commented Jul 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Jul 23, 2026, 9:30 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cshape
cshape requested a review from LordElf July 23, 2026 21:31

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@developer-guide/integrations/telnyx.mdx`:
- Line 21: Update the emotion control link in the Telnyx integration
documentation to use the relative path ../best-practices/emotion-control instead
of the root-relative path, while leaving the surrounding text unchanged.
- Line 11: Add a Python prerequisite alongside the Telnyx account requirement in
the integration guide, specifying installation of websockets version 14 or newer
with the appropriate pip command. Mention that this version is required for the
WebSocket example’s additional_headers argument.
- Around line 81-91: The Telnyx REST curl example should demonstrate saving MP3
audio. Update the request payload with voice_settings specifying format "mp3"
and a supported 44100 sample rate, and add --output output.mp3 to the curl
command while preserving the existing endpoint and authentication.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f7c64f3e-8e62-4e6d-90bc-52e5a766206a

📥 Commits

Reviewing files that changed from the base of the PR and between 3a8c858 and b24f88d.

⛔ Files ignored due to path filters (2)
  • images/pipecat-logo.svg is excluded by !**/*.svg
  • images/telnyx-logo.svg is excluded by !**/*.svg
📒 Files selected for processing (3)
  • developer-guide/integrations/pipecat.mdx
  • developer-guide/integrations/telnyx.mdx
  • docs.json

Comment thread developer-guide/integrations/telnyx.mdx
Comment thread developer-guide/integrations/telnyx.mdx
Comment thread developer-guide/integrations/telnyx.mdx
@cshape
cshape merged commit 1ac2cfe into main Jul 23, 2026
6 checks passed
@cshape
cshape deleted the docs/telnyx-integration branch July 23, 2026 21:46
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