Skip to content

Deprecate v1.6 for phoneme and adjust to reflect s1/s2 pro#88

Open
JarodMica wants to merge 2 commits into
fishaudio:mainfrom
JarodMica:update
Open

Deprecate v1.6 for phoneme and adjust to reflect s1/s2 pro#88
JarodMica wants to merge 2 commits into
fishaudio:mainfrom
JarodMica:update

Conversation

@JarodMica

@JarodMica JarodMica commented Jun 17, 2026

Copy link
Copy Markdown

The documentation under fine grained control refers to a deprecated v1.6 model. This PR:

  • Removes references to v1.6 in that document
  • Refers to S1 and S2 instead

Tests:

  • <|phoneme_start|> and <|phoneme_end|> tags still work for s2 pro and s1 in the web text-to-speech section and the API

Summary by CodeRabbit

  • Documentation
    • Updated Fine-grained Control guide with improved phoneme control instructions for s2-pro and s1 models
    • Introduced "Emotion and Paralanguage Control" section with model-specific syntax examples
    • Enhanced examples demonstrating combined use of phoneme and emotion/paralanguage features

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@JarodMica, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 38 minutes and 26 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

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.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 68f4647c-0916-4476-9fdd-a060379ef809

📥 Commits

Reviewing files that changed from the base of the PR and between af90742 and 2e62544.

📒 Files selected for processing (1)
  • developer-guide/core-features/fine-grained-control.mdx
📝 Walkthrough

Walkthrough

Documentation updates to fine-grained-control.mdx: the API playground card is reformatted with multiline JSX props; phoneme control guidance now specifies s2-pro or s1 models; the "Paralanguage" section is replaced with "Emotion and Paralanguage Control," which adds model-specific marker syntax ([bracket] vs (parentheses)) and a combined example.

Changes

Fine-grained Control Documentation

Layer / File(s) Summary
API playground card reformatting
developer-guide/core-features/fine-grained-control.mdx
The "Try it live" Card component is reformatted to multiline JSX props with line-wrapped description text; no destination or content changes.
Phoneme model guidance and Emotion/Paralanguage section
developer-guide/core-features/fine-grained-control.mdx
Playground guidance updated to name s2-pro and s1 as supported models for <|phoneme_start|> / <|phoneme_end|> tags. The "Paralanguage" section is replaced with "Emotion and Paralanguage Control," which links to the Emotion Control guide, documents [bracket] syntax for S2-Pro vs. (parentheses) for S1, and includes an updated combined emotion/paralanguage + phoneme example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Poem

A rabbit rewrote the guide with care,
Phonemes tagged with s2-pro flair,
[bracket] or (parens) — pick your style,
Emotion and language side by side, worthwhile.
🐇✨ Hop along, the docs shine bright!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main objective of the pull request: deprecating v1.6 model references and updating documentation to use S1/S2 Pro models instead.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@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: 2

🤖 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/core-features/fine-grained-control.mdx`:
- Line 20: The href attributes on line 20 and line 99 use absolute internal
paths starting with a forward slash instead of relative paths. Convert both
href="/api-reference/endpoint/openapi-v1/text-to-speech" occurrences to use
relative path syntax that properly references the target document based on the
current file's location in the directory structure, following the repository's
documentation guideline to use relative paths for all internal links.
- Line 101: The model names on line 101 use inconsistent casing and formatting
(S2-Pro and S1) compared to line 33 (s2-pro and s1). Update the references in
the sentence that begins with "S2-Pro uses `[bracket]`" to use lowercase model
IDs (s2-pro and s1) to match the existing naming convention and reduce user
confusion throughout the document.
🪄 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

Run ID: c6642d6c-30f5-4655-aa7f-0d989daf1c69

📥 Commits

Reviewing files that changed from the base of the PR and between ea2caf8 and af90742.

📒 Files selected for processing (1)
  • developer-guide/core-features/fine-grained-control.mdx

<Card
title="Try it live in the API playground"
icon="flask"
href="/api-reference/endpoint/openapi-v1/text-to-speech"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use relative internal links instead of absolute internal paths.

Line 20 and Line 99 use absolute internal URLs. Switch these to relative paths to match repo documentation rules.

Suggested update
-  href="/api-reference/endpoint/openapi-v1/text-to-speech"
+  href="../../api-reference/endpoint/openapi-v1/text-to-speech"
-For pauses, laughter, breathing, emotion, tone, and other paralinguistic cues, use the [Emotion Control](/developer-guide/core-features/emotions) guide.
+For pauses, laughter, breathing, emotion, tone, and other paralinguistic cues, use the [Emotion Control](../emotions) guide.

As per coding guidelines, "Use relative paths for internal links" and "Do not use absolute URLs for internal links."

Also applies to: 99-99

🤖 Prompt for 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.

In `@developer-guide/core-features/fine-grained-control.mdx` at line 20, The href
attributes on line 20 and line 99 use absolute internal paths starting with a
forward slash instead of relative paths. Convert both
href="/api-reference/endpoint/openapi-v1/text-to-speech" occurrences to use
relative path syntax that properly references the target document based on the
current file's location in the directory structure, following the repository's
documentation guideline to use relative paths for all internal links.

Source: Coding guidelines

Comment thread developer-guide/core-features/fine-grained-control.mdx Outdated
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