Skip to content

docs(platform): add Create Voice walkthroughs (Voice Design + PVC); drop Music card#86

Open
LordElf wants to merge 1 commit into
mainfrom
docs/platform-create-voice
Open

docs(platform): add Create Voice walkthroughs (Voice Design + PVC); drop Music card#86
LordElf wants to merge 1 commit into
mainfrom
docs/platform-create-voice

Conversation

@LordElf

@LordElf LordElf commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

What this adds

End-user, no-code walkthroughs for creating a voice in the Fish Audio web app, under a new Create Voice nav group (Platform → Create Voice):

  • Professional Voice Clone (overview/platform/create-voice/professional-voice-clone.mdx) — listed first; upload → analyze → verify → train → preview → release.
  • Voice Design (overview/platform/create-voice/voice-design.mdx) — describe → generate → pick → save.
  • Overview page: Professional Voice Clone added as a Core feature; the companion card retitled Voice Design.
  • Platform map: removed the standalone Music card (Sound Effects kept).

⚠️ Not ready to merge — pending capture

Five screenshots are still italic placeholders, and one needs a recapture:

  • vd-01-describe.png, vd-02-pick.png, vd-03-details.png (Voice Design steps)
  • pvc-05-preview.png, pvc-06-release.png (PVC steps)
  • Recapture pvc-04-training.png in an English-language clone (currently shows 汉语, inconsistent with the English verification shot above it)
  • Remove the {/* DRAFT NOTE ... */} comments from both pages once shots are in

Multi-agent review (5 dimensions, adversarially verified)

12 findings raised, 11 confirmed. Applied:

  • On-screen label fix: release visibility field is Type, not "Visibility".
  • Dropped the unverified "monthly slots / wait for reset" cadence (the UI exposes only used/limit + an upgrade-to-continue prompt).
  • Documented the terminal verification-failed state (model locked, contact support) and the full set of hub resume states (Draft / Awaiting Release / Trained / Training / Verification Failed).
  • Voice Design uses the full "Generate Samples" button label.
  • Cropped the hub screenshot so it no longer shows commercial-release / revenue-share copy.

Rejected with evidence (kept the content):

  • "Fabricated verification quotes" — the strings are real (platform-web/lib/voice-verification-error.ts:26-27); the review searched only i18n JSON.
  • "Confirmation dialog doesn't exist" — a captured screenshot proves it ships; the reviewed platform-web checkout predates it.

Notes

  • Source of truth cross-checked against platform-web (create-voice hub, voice-design wizard, professional-voice-clone flow) + provided screenshots.
  • Preview locally with mint dev.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guides for Professional Voice Clone feature, including upload, analysis, verification, training, and release workflows
    • Added Voice Design feature documentation with step-by-step instructions for voice creation and configuration
    • Reorganized navigation with new "Create Voice" section grouping voice-related features
    • Updated feature overview with new Professional Voice Clone and Voice Design cards
…rop Music card

Add end-user how-to walkthroughs for creating a voice in the web app:

- New pages overview/platform/create-voice/{professional-voice-clone,voice-design}.mdx
  with step-by-step instructions and screenshots; registered under a new "Create Voice"
  nav group (Professional Voice Clone first).
- Surface Professional Voice Clone as a Core feature on the Overview page; retitle the
  companion card to "Voice Design".
- Remove the standalone "Music" card from the platform map (Sound Effects kept).

Refinements from a multi-agent doc review (accuracy vs the web app source + screenshots):

- Use the real on-screen label "Type" for the release visibility field.
- Drop the unverified "monthly slots / wait for reset" cadence (the UI exposes only
  used/limit and an upgrade-to-continue prompt).
- Document the terminal verification-failed state (model locked, contact support) and the
  full set of hub resume states (Draft / Awaiting Release / Trained / Training / Failed).
- Use the full "Generate Samples" button label on the Voice Design page.
- Crop the hub screenshot so it no longer shows commercial-release / revenue-share copy.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 17, 2026 03:44
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cf279880-403a-4449-a612-db24d2dc166a

📥 Commits

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

⛔ Files ignored due to path filters (5)
  • images/platform/create-voice/01-hub.png is excluded by !**/*.png
  • images/platform/create-voice/pvc-00-confirm.png is excluded by !**/*.png
  • images/platform/create-voice/pvc-01-upload.png is excluded by !**/*.png
  • images/platform/create-voice/pvc-03-verify.png is excluded by !**/*.png
  • images/platform/create-voice/pvc-04-training.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • docs.json
  • overview/capabilities.mdx
  • overview/platform.mdx
  • overview/platform/create-voice/professional-voice-clone.mdx
  • overview/platform/create-voice/voice-design.mdx
💤 Files with no reviewable changes (1)
  • overview/platform.mdx

📝 Walkthrough

Walkthrough

Two new MDX pages are added under overview/platform/create-voice/: a full Professional Voice Clone guide (prerequisites, step-by-step flow, resume states, troubleshooting) and a Voice Design guide (method selection, sample generation, form completion, next steps). The sidebar navigation in docs.json is updated to expose these as a nested "Create Voice" group, and existing overview pages are updated to add/rename cards accordingly.

Changes

Create Voice Documentation

Layer / File(s) Summary
Navigation wiring and overview page updates
docs.json, overview/capabilities.mdx, overview/platform.mdx
docs.json replaces the flat overview/platform nav entry with a nested "Create Voice" group containing two subpages. overview/capabilities.mdx adds Professional Voice Clone and Voice Design cards and renames the Music & Sound Effects card to Sound Effects. overview/platform.mdx removes the Music card from the Create audio section.
Professional Voice Clone guide page
overview/platform/create-voice/professional-voice-clone.mdx
New page covering frontmatter, draft screenshot checklist, overview, prerequisites, the full step-by-step clone creation walkthrough (upload → analysis → ownership verification → training → preview → release), resume-in-progress state mapping, and an accordion troubleshooting section.
Voice Design guide page
overview/platform/create-voice/voice-design.mdx
New page covering frontmatter, draft screenshot checklist, step-by-step instructions for choosing a method, generating and selecting sample voices, completing the Voice Details form, and a Next Steps card section linking to PVC and voice management.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 Hop hop, new pages appear!
Two voice paths are now crystal clear,
A clone, a design, side by side,
The nav tree grows with bunny pride.
Screenshots pending — soon they'll gleam,
Docs complete, a rabbit's dream! 🌟

🚥 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 clearly and concisely summarizes the three main changes: adding two new voice creation walkthroughs (Professional Voice Clone and Voice Design) under a new Create Voice section, and removing the Music card.
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
  • Commit unit tests in branch docs/platform-create-voice

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.

@mintlify

mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Jun 17, 2026, 3:45 AM

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user walkthrough documentation for creating voices in the Fish Audio web app, and updates overview navigation/landing pages to surface the new “Create Voice” section while removing the Music entry.

Changes:

  • Added new Create Voice MDX walkthrough pages for Professional Voice Clone and Voice Design.
  • Updated Capabilities overview to include Professional Voice Clone (core) and Voice Design (web app), and adjusted “Music & Sound Effects” to “Sound Effects”.
  • Updated Platform (Web App) map and docs.json navigation: removed the Music card and added a new “Create Voice” nav group.

Reviewed changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
overview/platform/create-voice/voice-design.mdx New Voice Design walkthrough (currently contains draft notes + screenshot placeholders).
overview/platform/create-voice/professional-voice-clone.mdx New PVC walkthrough (currently contains draft notes + screenshot placeholders).
overview/platform.mdx Removes Music card from the Platform (Web App) map.
overview/capabilities.mdx Adds Create Voice-related cards; retitles Music/SFX section to Sound Effects.
docs.json Adds “Create Voice” nav group under Platform (Web App).

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

Comment on lines +7 to +11
{/*
DRAFT NOTE (remove before publishing): screenshots are placeholders shown as italic lines.
Capture each on https://fish.audio/app (logged in), save to the path below, then replace the
italic line with a <Frame>, e.g.:
<Frame><img src="/images/platform/create-voice/vd-01-describe.png" alt="..." /></Frame>
method**, choose **Voice Design**.

<Frame>
<img src="/images/platform/create-voice/01-hub.png" alt="The Create Voice hub with the Instant Voice Clone and Voice Design methods" />
Check the cost note (for example, **2000 credits per generation**, or **Free for a limited
time** during a promotion), then click **Generate Samples**.

_Screenshot: the description box, starter prompts, and the Generate button._
Click **Select** on the sample you want — it changes to **Selected** — then click
**Continue**.

_Screenshot: the two sample cards with one Selected and Continue enabled._
person and complies with Fish Audio's usage policy."*), then click **Create Voice**. Your
voice is saved and you land on **My Voices**.

_Screenshot: the Voice Details form with the visibility options and confirmation box._
Comment on lines +7 to +11
{/*
DRAFT NOTE (remove before publishing): two screenshots are still placeholders (italic lines).
Capture each on https://fish.audio/app (logged in), save to the path below, then replace the
italic line with a <Frame>, e.g.:
<Frame><img src="/images/platform/create-voice/pvc-05-preview.png" alt="..." /></Frame>
listen. To test your own words, click **Custom preview text**, type a sentence, and click
**Generate Preview**.

_Screenshot: the preview samples and the custom preview input._
model."*) and click **Create Voice**. Your professional voice is published and you land on
its model page.

_Screenshot: the release form with the confirmation box._
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants