TEST-46 docs: align guides with voice testing best practices - #1206
Merged
Conversation
scott-lowe-vapi
marked this pull request as ready for review
September 9, 2026 22:33
Lightsage docs evalsResult: passed Average score: 100/100
|
scott-lowe-vapi
requested review from
bets-margulies-vapi,
chris-garber-vapi and
stephenvapiai
September 9, 2026 22:33
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a08872-d1b4-7740-bdae-406995015707.docs.buildwithfern.com |
stephenvapiai
approved these changes
Sep 10, 2026
stephenvapiai
left a comment
stephenvapiai
left a comment
Contributor
There was a problem hiding this comment.
I only made one change and that was splitting a large paragraph into two.
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a08c65-a4a1-725d-bb68-cad6b17a9672.docs.buildwithfern.com |
| A record of an eval execution, including its target, status, results, | ||
| costs, completion details, and lifecycle timestamps. | ||
| properties: | ||
| results: |
There was a problem hiding this comment.
interesting, I don't know if these overrides can/should get backpropagated into comments in the code, haven't looked into how our autogeneration works
## Description - Align Evals and Simulations guides with the testing best practices introduced in #1193. - Clarify tool, audio, and external-state boundaries; replace brittle examples with focused decision checks. - Replace incomplete CI snippets with a workflow that waits for completion and blocks on critical failures. - Add risk-based coverage guidance to tutorials, monitoring, and scorecards; correct stale Eval-suite API descriptions through Fern overrides. - Follow-up for [TEST-46](https://linear.app/vapi/issue/TEST-46/update-docs-for-testing-best-practices). ## Testing Steps - [ ] Run the app locally using `fern docs dev` or navigate to preview deployment. Local preview stalled during startup; visual review remains pending. - [ ] Ensure that the changed pages and code snippets work. Static checks passed; no live calls or Eval runs were made. - [x] `fern check`: 0 errors, 12 existing API-schema warnings. - [x] MDX/YAML syntax checks for all 13 changed files, changed cURL JSON payloads, new internal links, and `git diff --check`. - [x] CI example validated with 12 mocked cases covering passing results, failures, cancellation, missing/empty results, timeout, HTTP/JSON errors, and missing configuration.
scott-lowe-vapi
force-pushed
the
codex/align-testing-guidance
branch
from
September 10, 2026 23:40
0591673 to
6c5325e
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a08de0-3571-707a-b978-7459302f1527.docs.buildwithfern.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
3 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.
Description
Testing Steps
fern docs devor navigate to preview deployment. Local preview stalled during startup; visual review remains pending.fern check: 0 errors, 12 existing API-schema warnings.git diff --check.