[Maxim] Voice simulation runs docs

[impoiler]

No description provided.

[impoiler]

• [Maxim] Voice simulation runs docs #159 👈 (View in Graphite)
• [Maxim] Test run report tags docs #158
• [Maxim] Human eval docs #155
• [Maxim] Varibles mapping docs #154
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Added a new Voice Simulation "simulation runs" documentation page with end-to-end guidance for creating datasets, configuring runs, selecting evaluators, and inspecting entries.
  • Documents captured audio metrics (avg latency, talk ratio, avg pitch, words per minute) and includes UI screenshots for setup, results review, and per-entry inspection.
  • Expanded Voice Simulation docs to include simulation runs.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Adds a new documentation page "simulation-runs" under Voice Simulation and updates navigation metadata to register the page; the MDX documents dataset creation, running large-scale voice simulations, captured audio metrics, UI guidance, and per-scenario result inspection.

Changes

Cohort / File(s)	Summary
Navigation / Manifest simulations/meta.json, docs.json	Updated the voice-simulation pages list to include simulation-runs alongside voice-simulation to register the new documentation page.
New Documentation Page simulations/voice-simulation/simulation-runs.mdx	Added an MDX page describing dataset creation, test run configuration (simulated-session mode), evaluator selection, metrics captured from audio (avg latency, talk ratio, avg pitch, words per minute), UI screenshots/guidance, and per-entry result inspection and transcriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Check JSON syntax and ordering in simulations/meta.json and docs.json.
• Validate internal links and image paths in simulations/voice-simulation/simulation-runs.mdx.
• Skim content for consistency with existing voice-simulation docs.

Poem

🐰
A page unrolls where voices play,
Datasets march and tests survey,
Pitch and pace in gentle hum,
Results revealed — the insights come,
I nibble notes and hop away. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author; the PR lacks any written description of the changes.	Add a pull request description explaining what the documentation covers and why it was added to help reviewers understand the context.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title '[Maxim] Voice simulation runs docs' clearly summarizes the main change: adding documentation for voice simulation runs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch improvement/voice-simulation-testrun

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6e4220 and 3b25ab5.

⛔ Files ignored due to path filters (4)

• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/single-entry-result.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/trigger-voice-simulation-testrun.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/voice-agent-dataset.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/voice-simulation-testrun-report.png is excluded by !**/*.png

📒 Files selected for processing (3)

• docs.json (1 hunks)
• simulations/meta.json (1 hunks)
• simulations/voice-simulation/simulation-runs.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• docs.json
• simulations/voice-simulation/simulation-runs.mdx
• simulations/meta.json

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4270cd6 and c6282c1.

⛔ Files ignored due to path filters (4)

• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/single-entry-result.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/trigger-voice-simulation-testrun.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/voice-agent-dataset.png is excluded by !**/*.png
• images/docs/evaluate/how-to/evaluate-workflows-via-api-endpoint/evaluate-simulated-voice-agent/voice-simulation-testrun-report.png is excluded by !**/*.png

📒 Files selected for processing (3)

• docs.json (1 hunks)
• simulations/meta.json (1 hunks)
• simulations/voice-simulation/simulation-runs.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check

🔇 Additional comments (2)

simulations/meta.json (1)

10-10: Navigation metadata correctly updated.

The addition of "simulation-runs" to the voice-simulation pages array is consistent with the parallel text-simulation structure and aligns with the docs.json navigation changes.

docs.json (1)

193-196: Navigation structure correctly aligned with meta.json and mirrors text-simulation pattern.

The Voice Simulation group now includes both the main page and a simulation-runs procedures page, providing consistent navigation structure across text and voice simulation documentation sections.

[impoiler]

Merge activity

• Nov 3, 4:51 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Nov 5, 4:20 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Nov 5, 4:45 AM UTC: Graphite couldn't merge this pull request because a downstack PR [Maxim] Varibles mapping docs #154 failed to merge.
• Nov 5, 2:50 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Nov 5, 2:53 PM UTC: Graphite couldn't merge this pull request because a downstack PR [Maxim] Human eval docs #155 failed to merge.
• Nov 5, 3:08 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Nov 5, 3:10 PM UTC: Graphite couldn't merge this PR because it was not satisfying all requirements (PR does not have required approvals).

The base branch was changed.