docs: rewrite prompting guide and add downloadable reference#1049
Merged
Conversation
Rewrites the prompting guide with voice-specific best practices (six-section structure, guardrails, few-shot examples, anti-patterns). Adds a downloadable .md reference file for use with Claude Code or other AI coding assistants. Fixes broken links, adds internal cross-links to related docs pages, and cleans up formatting. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-cf64dd53-25ab-4281-aa74-361974cf1378.docs.buildwithfern.com |
Replace Card href with Fern's built-in Download component which handles file downloads correctly via relative src path. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-5fc3a741-d29a-4739-91a2-103ca8dfdac9.docs.buildwithfern.com |
Adds "Making your agent sound human" section covering disfluency design, rapport patterns, banter vs off-topic handling, energy matching, turn budgeting, emotional expression frequency, incremental tool calls, read-back strategy, and call ending rules. Informed by patterns from the Vapi qualification demo agent. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-b7f8445e-c806-4131-a2c6-a7e0714a54a7.docs.buildwithfern.com |
Pronunciation hints in the prompt can help depending on the voice provider. Updated both files to recommend using prompt-level hints alongside TTS-layer pronunciation dictionaries, rather than saying prompt hints don't work. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Makes it clear that TTS-layer pronunciation dictionaries are currently ElevenLabs-only, so prompt-level hints are the primary pronunciation tool for other voice providers. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The pronunciation dictionaries page only documents ElevenLabs but other providers may also support them. Reverted to provider-neutral language. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-dddc7952-b2d5-4319-bdd9-01b70f2d03eb.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-c8487a37-dc01-4f25-93c5-bef0f892dcf5.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-3b52380f-ef8a-4429-b0a7-e726ac4ab21d.docs.buildwithfern.com |
roshan-vapi
approved these changes
May 14, 2026
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
2 participants
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
.mdreference file (fern/static/vapi-prompt-reference.md) for users to drop into Claude Code or other AI assistantsTest plan
/static/vapi-prompt-reference.mdserves the raw file/debugging,/tools,/squads,/assistants/dynamic-variables, etc.)#principles-of-effective-prompts,#example-complete-prompt-template, etc.)🤖 Generated with Claude Code