Restructure voice and spoken terms documentation - #413
Merged
Conversation
- Split the monolithic api-reference/spoken-terms.mdx page into the per-endpoint reference pages, with a redirect to the create endpoint - Add spoken terms guide and requirements pages under Customize, with a new Spoken Terms nav group and ia.yaml entry - Add spoken terms to the customize overview feature table and cards - Replace docs/voice/supported-languages-formats-and-limits with supported-voice-languages and voice-api-requirements, with a redirect - Document term entry validation rules and the per-plan collection limit in the OpenAPI spec - Update voice-related links in the changelog and voice translate job reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Add a "What each feature does" header above the feature table - Clarify combinability: the translation features combine in a single request, while spoken terms combine only with glossaries - Rename "Start here" to "Feature guides" since it isn't at the top of the page, and trim the cards to one guide per feature
- Describe Spoken Terms as ensuring correct transcription of domain-specific vocabulary instead of fixing mistranscriptions - Spoken Terms are available on all plans that include the DeepL Voice API, not "select API Pro plans" (guide and requirements page) - Clarify PUT vs PATCH in the replace section instead of "don't merge; replace"
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
1 participant
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
api-reference/spoken-terms.mdxpage into the existing per-endpoint reference pages, removing it from nav and redirecting/api-reference/spoken-termsto the create endpointia.yamlentrydocs/voice/supported-languages-formats-and-limitswith two focused pages:supported-voice-languagesandvoice-api-requirements(with a redirect from the old URL)Test plan
mint broken-linksandmint broken-links --check-anchorspass for the affected pages/api-reference/spoken-termsand/docs/voice/supported-languages-formats-and-limitsin the preview deployment🤖 Generated with Claude Code