Skip to content

Commit c9efaf4

Browse files
authored
Workflow docs revision (#462)
* fix: remove workflows section icon * fix(workflows): broken link on overview * fix: crop videos to remove dashboard * fix(workflows): broken quickstart icon * fix: replace `behaviour` with `behavior` * fix(workflows): include conditions, first messages, prompts for all nodes * chore: rename `outbound-sales` example to `lead-qualification` * fix: undo `widget.js` changes * fix(appointment-scheduling): remove unnecessary condition step * feat(workflows): add final screenshots * fix(workflows/examples): use code block titles for clarity * chore: disable claude CI check
1 parent 8f169f0 commit c9efaf4

18 files changed

+1011
-215
lines changed

.github/workflows/pr-review.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ on:
44
pull_request:
55
types: [opened, synchronize, reopened]
66
paths:
7-
- 'fern/**/*.mdx'
8-
- 'fern/**/*.yml'
9-
- 'fern/**/*.yaml'
7+
- "fern/**/*.mdx"
8+
- "fern/**/*.yml"
9+
- "fern/**/*.yaml"
1010

1111
jobs:
1212
review:
1313
runs-on: ubuntu-latest
14+
if: false
1415
permissions:
1516
contents: read
1617
pull-requests: write
17-
18+
1819
steps:
1920
- uses: actions/checkout@v4
2021

@@ -30,7 +31,7 @@ jobs:
3031
- name: ⚙️ Setup Node.js
3132
uses: actions/setup-node@v4
3233
with:
33-
node-version: '18'
34+
node-version: "18"
3435

3536
- name: 🤖 Install Claude Code
3637
run: npm install -g @anthropic-ai/claude-code
@@ -44,7 +45,7 @@ jobs:
4445
echo "" >> review.md
4546
echo "Hey there! 👋 I've reviewed your documentation changes against our style guidelines. Here's what I found:" >> review.md
4647
echo "" >> review.md
47-
48+
4849
for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
4950
echo "🔍 Reviewing $file..."
5051
@@ -137,7 +138,7 @@ jobs:
137138
echo "---" >> review.md
138139
echo "" >> review.md
139140
done
140-
141+
141142
echo "📖 [Style Guidelines](.cursorrules) | Thanks for contributing! 🙏✨" >> review.md
142143
143144
- name: 💬 Comment on PR
@@ -147,10 +148,10 @@ jobs:
147148
script: |
148149
const fs = require('fs');
149150
const review = fs.readFileSync('review.md', 'utf8');
150-
151+
151152
await github.rest.issues.createComment({
152153
owner: context.repo.owner,
153154
repo: context.repo.repo,
154155
issue_number: context.issue.number,
155156
body: review
156-
});
157+
});

fern/docs.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ navigation:
125125

126126
- section: Assistant customization
127127
contents:
128-
- section: Conversation behaviour
128+
- section: Conversation behavior
129129
icon: fa-light fa-comments
130130
contents:
131131
- page: Variables
@@ -213,11 +213,10 @@ navigation:
213213
path: customization/custom-llm/tool-calling-integration.mdx
214214

215215
- section: Workflows
216-
icon: fa-light fa-diagram-project
217216
contents:
218217
- page: Quickstart
219218
path: workflows/quickstart.mdx
220-
icon: fa-light fa-bolt-lightning
219+
icon: fa-light fa-rocket
221220
- page: Overview
222221
path: workflows/overview.mdx
223222
icon: fa-light fa-eye
@@ -227,15 +226,15 @@ navigation:
227226
- page: Appointment scheduling
228227
path: workflows/examples/appointment-scheduling.mdx
229228
icon: fa-light fa-calendar-check
230-
- page: Outbound sales
231-
path: workflows/examples/outbound-sales.mdx
229+
- page: Lead qualification
230+
path: workflows/examples/lead-qualification.mdx
232231
icon: fa-light fa-money-bill-wave
233232
- page: Medical triage
234233
path: workflows/examples/clinic-triage-scheduling.mdx
235234
icon: fa-light fa-stethoscope
236235
- page: Order management
237236
path: workflows/examples/ecommerce-order-management.mdx
238-
icon: fa-light fa-shopping-cart
237+
icon: fa-light fa-shopping-cart
239238

240239
- section: Best practices
241240
contents:
@@ -800,3 +799,5 @@ redirects:
800799
destination: /api-reference/assistants/create
801800
- source: /examples/voice-widget.mdx
802801
destination: /sdk/web
802+
- source: /workflows/examples/outbound-sales.mdx
803+
destination: /workflows/examples/lead-qualification.mdx

fern/examples/voice-widget.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Improve your website's user interaction with the Vapi Voice Widget. This robust
9797
</Step>
9898

9999
<Step title="Add Functionality to Vapi Instance">
100-
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.
100+
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.
101101

102102
```js
103103
vapiInstance.on('speech-start', () => {

fern/quickstart/dashboard.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Vapi makes it easy to build end-to-end voice agents, which we call ***assistants
135135
When you click on the outbound call button, your assistant will make an outbound call to the phone number.
136136
<Tip>
137137
Your assistant won't yet be able to hang-up the phone at the end of the call.
138-
You will learn more about configuring call end behaviour in later guides.
138+
You will learn more about configuring call end behavior in later guides.
139139
</Tip>
140140
</Step>
141-
</Steps>
141+
</Steps>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
spoken letter by letter "V. A. P. I."
9494

9595
Some aspects of configuring your voice pipeline will require tweaks like this to get the target
96-
behaviour you want.
96+
behavior you want.
9797

9898
</Info>
9999

@@ -102,7 +102,7 @@
102102
<Accordion title="Set the System Prompt" icon="message" iconType="solid">
103103
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)).
104104

105-
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:
105+
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:
106106

107107
```text
108108
You are a voice assistant for Vappy’s Pizzeria,
Loading
Loading
Loading
Loading
Binary file not shown.
Binary file not shown.

fern/static/videos/upload-files.mp4

-468 KB
Binary file not shown.
-698 KB
Binary file not shown.

0 commit comments

Comments
 (0)