Workflow docs revision

.github/workflows/pr-review.yml

@@ -4,17 +4,18 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
     paths:
-      - 'fern/**/*.mdx'
-      - 'fern/**/*.yml'
-      - 'fern/**/*.yaml'
+      - "fern/**/*.mdx"
+      - "fern/**/*.yml"
+      - "fern/**/*.yaml"
 
 jobs:
   review:
     runs-on: ubuntu-latest
+    if: false
     permissions:
       contents: read
       pull-requests: write
-    
+
     steps:
       - uses: actions/checkout@v4
 
@@ -30,7 +31,7 @@ jobs:
       - name: ⚙️ Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: "18"
 
       - name: 🤖 Install Claude Code
         run: npm install -g @anthropic-ai/claude-code
@@ -44,7 +45,7 @@ jobs:
           echo "" >> review.md
           echo "Hey there! 👋 I've reviewed your documentation changes against our style guidelines. Here's what I found:" >> review.md
           echo "" >> review.md
-          
+
           for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
             echo "🔍 Reviewing $file..."
 
@@ -137,7 +138,7 @@ jobs:
             echo "---" >> review.md
             echo "" >> review.md
           done
-          
+
           echo "📖 [Style Guidelines](.cursorrules) | Thanks for contributing! 🙏✨" >> review.md
 
       - name: 💬 Comment on PR
@@ -147,10 +148,10 @@ jobs:
           script: |
             const fs = require('fs');
             const review = fs.readFileSync('review.md', 'utf8');
-            
+
             await github.rest.issues.createComment({
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: context.issue.number,
               body: review
-            }); 
+            });

fern/docs.yml

@@ -125,7 +125,7 @@ navigation:
 
       - section: Assistant customization
         contents:
-          - section: Conversation behaviour
+          - section: Conversation behavior
             icon: fa-light fa-comments
             contents:
               - page: Variables
@@ -213,11 +213,10 @@ navigation:
                 path: customization/custom-llm/tool-calling-integration.mdx
 
       - section: Workflows
-        icon: fa-light fa-diagram-project
         contents:
           - page: Quickstart
             path: workflows/quickstart.mdx
-            icon: fa-light fa-bolt-lightning
+            icon: fa-light fa-rocket
           - page: Overview
             path: workflows/overview.mdx
             icon: fa-light fa-eye
@@ -227,15 +226,15 @@ navigation:
               - page: Appointment scheduling
                 path: workflows/examples/appointment-scheduling.mdx
                 icon: fa-light fa-calendar-check
-              - page: Outbound sales
-                path: workflows/examples/outbound-sales.mdx
+              - page: Lead qualification
+                path: workflows/examples/lead-qualification.mdx
                 icon: fa-light fa-money-bill-wave
               - page: Medical triage
                 path: workflows/examples/clinic-triage-scheduling.mdx
                 icon: fa-light fa-stethoscope
               - page: Order management
                 path: workflows/examples/ecommerce-order-management.mdx
-                icon: fa-light fa-shopping-cart      
+                icon: fa-light fa-shopping-cart
 
       - section: Best practices
         contents:
@@ -800,3 +799,5 @@ redirects:
     destination: /api-reference/assistants/create
   - source: /examples/voice-widget.mdx
     destination: /sdk/web
+  - source: /workflows/examples/outbound-sales.mdx
+    destination: /workflows/examples/lead-qualification.mdx

fern/examples/voice-widget.mdx

@@ -97,7 +97,7 @@ Improve your website's user interaction with the Vapi Voice Widget. This robust
   </Step>
 
   <Step title="Add Functionality to Vapi Instance">
-    You can use the `vapiInstance` returned from the run function in the snippet to further customize the behaviour. For instance, you might want to listen to various EventSource, or even send some messages to the bot programmatically.
+    You can use the `vapiInstance` returned from the run function in the snippet to further customize the behavior. For instance, you might want to listen to various EventSource, or even send some messages to the bot programmatically.
 
     ```js
       vapiInstance.on('speech-start', () => {

fern/quickstart/dashboard.mdx

@@ -135,7 +135,7 @@ Vapi makes it easy to build end-to-end voice agents, which we call ***assistants
     When you click on the outbound call button, your assistant will make an outbound call to the phone number. 
     <Tip>
       Your assistant won't yet be able to hang-up the phone at the end of the call.
-      You will learn more about configuring call end behaviour in later guides.
+      You will learn more about configuring call end behavior in later guides.
     </Tip>
   </Step>
-</Steps>
+</Steps>

fern/snippets/quickstart/dashboard/assistant-setup-inbound.mdx

@@ -93,7 +93,7 @@
           spoken letter by letter "V. A. P. I."
 
         Some aspects of configuring your voice pipeline will require tweaks like this to get the target
-        behaviour you want.
+        behavior you want.
 
         </Info>
 
@@ -102,7 +102,7 @@
       <Accordion title="Set the System Prompt" icon="message" iconType="solid">
         We will now set the `System Prompt` for our assistant. If you're familiar with OpenAI's API, this is the first prompt in the message list that we feed our LLM (learn more about prompt engineering on the [OpenAI docs](https://platform.openai.com/docs/guides/prompt-engineering)).
 
-        The system prompt can be used to configure the context, role, personality, instructions and so on for the assistant. In our case, a system prompt like this will give us the behaviour we want:
+        The system prompt can be used to configure the context, role, personality, instructions and so on for the assistant. In our case, a system prompt like this will give us the behavior we want:
 
         ```text
         You are a voice assistant for Vappy’s Pizzeria,