Conversation
Co-Authored-By: adinoto@assemblyai.com <adinoto@assemblyai.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
…code examples Co-Authored-By: adinoto@assemblyai.com <adinoto@assemblyai.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds Python SDK and JavaScript SDK code examples to all 12 sections with code blocks on the Universal 3 Pro documentation page. Each section now has 4 tabs: Python SDK (default), Python (raw API), JavaScript SDK, and JavaScript (raw API).
The SDK examples use the official AssemblyAI SDKs (
assemblyaifor Python,assemblyaifor JavaScript) which provide a simpler, more idiomatic interface compared to the raw API examples.Additionally, this PR fixes incorrect audio file URLs in two sections:
verbatim.mp3tonumbers_formatting.mp3verbatim.mp3toDifficult_audio.mp3Updates since last revision
Added syntax highlighting to SDK code examples to match the non-SDK code. For sections with
promptortemperatureparameters, the relevant lines are now highlighted (e.g.,{11}for single-line parameters,{13-14}for multi-line parameters). This ensures visual consistency between SDK and raw API code blocks.Review & Testing Checklist for Human
{11}should highlight thepromptline)fern docs devand verify all tabs render correctly with proper syntax highlightingtemperatureparameter in the Temperature section is correctly passed to the SDK config and highlightedRecommended test plan: Run the docs locally with
fern docs devand navigate to the Universal 3 Pro page. Click through each tab in every code block section to verify they display correctly, the code examples are syntactically valid, and the highlighted lines match between SDK and non-SDK tabs.Notes
The CI
fern-checkandlintfailures are pre-existing issues intranscripts.yml(API spec files), not related to documentation changes. The docs check passed:[docs]:✓ All checks passed.Requested by: adinoto@assemblyai.com
Link to Devin run: https://app.devin.ai/sessions/346def412c0d41c7a4839caa36d5c3f6