Skip to content

Commit 98eb623

Browse files
docs(chore): add draft status indicators to observability guides
Add internal-note banners indicating completion status for VAPI reviewers: Rough Draft (3 pages - content present, needs refinement): - observability-framework.mdx - instrumentation.mdx - testing-strategies.mdx Skeleton Draft (3 pages - structure only, detailed content pending): - production-readiness.mdx (iteration 3) - monitoring.mdx (iteration 2) - optimization-workflows.mdx (iteration 2) This helps reviewers calibrate expectations for which pages are ready for content review vs. structural/architectural review only.
1 parent 214099e commit 98eb623

6 files changed

Lines changed: 13 additions & 1 deletion

File tree

fern/observability/instrumentation.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Configure your assistant to capture operational and business metrics
44
slug: observability/instrumentation
55
---
66

7+
<span className="internal-note">This page is in Rough Draft stage</span>
8+
79
## What is instrumentation?
810

911
**Instrumentation** means configuring your assistant to capture data during and after calls. Before you can test, monitor, or optimize, you need to define **what data to capture**.

fern/observability/monitoring.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Visualize trends, track operational health, and ensure production reli
44
slug: observability/monitoring
55
---
66

7+
<span className="internal-note">This page is in Skeleton Draft stage - structure and scope for review, detailed content to be developed in iteration 2</span>
8+
79
## What is monitoring and operating?
810

911
**Monitoring & Operating** means running your voice AI system in production with continuous visibility into its health and performance. This stage answers critical operational questions:

fern/observability/observability-framework.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: A systematic framework for building, testing, and improving voice AI a
44
slug: observability/framework
55
---
66

7+
<span className="internal-note">This page is in Rough Draft stage</span>
8+
79
## What is observability for voice AI?
810

911
Observability for voice AI means **instrumenting your assistants to capture data**, **testing them before production**, **extracting insights from calls**, **monitoring operational health**, and **using that data to continuously improve**.

fern/observability/optimization-workflows.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Use observability data to continuously improve your assistant
44
slug: observability/optimization-workflows
55
---
66

7+
<span className="internal-note">This page is in Skeleton Draft stage - structure and scope for review, detailed content to be developed in iteration 2</span>
8+
79
## What is optimization?
810

911
**Optimization** is the continuous improvement loop: using observability data to refine prompts, improve tool calls, and enhance conversation flows.

fern/observability/production-readiness.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Validate your voice AI assistant is ready for production deployment
44
slug: observability/production-readiness
55
---
66

7+
<span className="internal-note">This page is in Skeleton Draft stage - structure and scope for review, detailed content to be developed in iteration 3</span>
8+
79
## What is production readiness?
810

911
**Production readiness** means your voice assistant has been systematically validated across instrumentation, testing, extraction, and monitoring **before** you deploy it to handle real customer calls.
@@ -16,7 +18,7 @@ Deploying without production readiness means:
1618

1719
**This checklist helps you avoid those problems** by ensuring you've instrumented, tested, and validated before launch.
1820

19-
<span className="internal-note"> Does VAPI have internal prod readiness criteria we should align with?</span>
21+
<span className="vapi-validation"> Does VAPI have internal prod readiness criteria we should align with?</span>
2022

2123
---
2224

fern/observability/testing-strategies.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ subtitle: Validate your assistant works correctly before deploying to production
44
slug: observability/testing-strategies
55
---
66

7+
<span className="internal-note">This page is in Rough Draft stage</span>
8+
79
## Voice AI Testing Challenges
810

911
**Testing** means validating your assistant works correctly **before deploying to production**. Voice AI testing prevents embarrassing failures, reduces production debugging costs, and builds confidence in your assistant.

0 commit comments

Comments
 (0)