Skip to content

Commit 6399b60

Browse files
committed
chore: reorganize examples into assistant- and workflow-based sections
1 parent 96c77d4 commit 6399b60

File tree

7 files changed

+34
-25
lines changed

7 files changed

+34
-25
lines changed
File renamed without changes.

fern/examples/inbound-support.mdx renamed to fern/assistants/examples/inbound-support.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ We will be creating a customer support agent for VapiBank, a bank that wants to
3333
<Steps>
3434
<Step title="Download the spreadsheets">
3535
<div className="flex gap-2">
36-
<Download src="../static/spreadsheets/inbound-support/accounts.csv">
36+
<Download src="../../static/spreadsheets/inbound-support/accounts.csv">
3737
<Button intent="primary">Download accounts.csv</Button>
3838
</Download>
39-
<Download src="../static/spreadsheets/inbound-support/transactions.csv">
39+
<Download src="../../static/spreadsheets/inbound-support/transactions.csv">
4040
<Button intent="primary">Download transactions.csv</Button>
4141
</Download>
4242
</div>
@@ -48,7 +48,7 @@ We will be creating a customer support agent for VapiBank, a bank that wants to
4848
2. Click **Choose file** and upload both `accounts.csv` and `transactions.csv`
4949
3. Note the file IDs for use in creating tools
5050

51-
<video autoPlay loop muted src="../static/videos/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
51+
<video autoPlay loop muted src="../../static/videos/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
5252
</Tab>
5353
<Tab title="TypeScript (Server SDK)">
5454
```typescript
@@ -132,7 +132,7 @@ We will be creating a customer support agent for VapiBank, a bank that wants to
132132
- Select `Blank Template` as your starting point.
133133
- Change assistant name to `Tom`.
134134

135-
<video autoPlay loop muted src="../static/videos/inbound-support/create-assistant.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
135+
<video autoPlay loop muted src="../../static/videos/inbound-support/create-assistant.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
136136
</Step>
137137
</Steps>
138138
</Tab>
@@ -527,7 +527,7 @@ You have access to CSV files with account and transaction data:
527527
<Tab title="Dashboard">
528528
Click `Talk to Assistant` to test it out.
529529

530-
<video autoPlay loop muted src="../static/videos/inbound-support/configure-assistant.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
530+
<video autoPlay loop muted src="../../static/videos/inbound-support/configure-assistant.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
531531
</Tab>
532532
<Tab title="TypeScript (Server SDK)">
533533
```typescript
@@ -662,7 +662,7 @@ You have access to CSV files with account and transaction data:
662662
- In the expanded accordion, add `get_balance` and `get_recent_transactions` tools.
663663
- Click `Publish` to save your changes.
664664

665-
<video autoPlay loop muted src="../static/videos/inbound-support/assistant-tools.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
665+
<video autoPlay loop muted src="../../static/videos/inbound-support/assistant-tools.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
666666
</Step>
667667
</Steps>
668668
</Tab>
@@ -915,7 +915,7 @@ You have access to CSV files with account and transaction data:
915915
- Under `Inbound Settings` find `Assistant` dropdown and select `Tom` from the list.
916916
- Changes are saved automatically.
917917

918-
<video autoPlay loop muted src="../static/videos/inbound-support/assign-phone-number.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
918+
<video autoPlay loop muted src="../../static/videos/inbound-support/assign-phone-number.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
919919
</Step>
920920
</Steps>
921921
</Tab>
@@ -998,7 +998,7 @@ You have access to CSV files with account and transaction data:
998998
- Accept the generated test case.
999999
- Click `Run Test Suite` to execute the tests.
10001000

1001-
<video autoPlay loop muted src="../static/videos/inbound-support/create-test-suite.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
1001+
<video autoPlay loop muted src="../../static/videos/inbound-support/create-test-suite.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
10021002
</Step>
10031003
<Step title="Run the test suite">
10041004
Click `Run Tests` to execute the tests.
File renamed without changes.

fern/docs.yml

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,19 +113,9 @@ navigation:
113113
- page: Orchestration models
114114
icon: fa-light fa-network-wired
115115
path: how-vapi-works.mdx
116-
- section: Examples
117-
icon: fa-light fa-code
116+
- page: Examples Library
117+
icon: fa-light fa-book-open
118118
path: examples.mdx
119-
contents:
120-
- page: Inbound support
121-
path: examples/inbound-support.mdx
122-
icon: fa-light fa-phone-volume
123-
- page: Voice widget
124-
path: examples/voice-widget.mdx
125-
icon: fa-light fa-window-maximize
126-
- page: Documentation agent
127-
path: examples/docs-agent.mdx
128-
icon: fa-light fa-microphone
129119

130120
- section: Assistants
131121
contents:
@@ -215,6 +205,19 @@ navigation:
215205
path: customization/custom-llm/using-your-server.mdx
216206
- page: Tool calling integration
217207
path: customization/custom-llm/tool-calling-integration.mdx
208+
- section: Examples
209+
icon: fa-light fa-code
210+
path: examples.mdx
211+
contents:
212+
- page: Inbound support
213+
path: assistants/examples/inbound-support.mdx
214+
icon: fa-light fa-phone-volume
215+
- page: Voice widget
216+
path: assistants/examples/voice-widget.mdx
217+
icon: fa-light fa-window-maximize
218+
- page: Documentation agent
219+
path: assistants/examples/docs-agent.mdx
220+
icon: fa-light fa-microphone
218221

219222
- section: Workflows
220223
contents:
@@ -821,3 +824,9 @@ redirects:
821824
destination: /workflows/quickstart
822825
- source: /web-integration
823826
destination: /web
827+
- source: /examples/inbound-support
828+
destination: /assistants/examples/inbound-support
829+
- source: /examples/voice-widget
830+
destination: /assistants/examples/voice-widget
831+
- source: /examples/docs-agent
832+
destination: /assistants/examples/docs-agent

fern/examples.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ slug: examples
55
---
66

77
<CardGroup cols={2}>
8-
<Card title="Docs Agent" icon="book-open" href="/examples/docs-agent">
8+
<Card title="Docs Agent" icon="book-open" href="/assistants/examples/docs-agent">
99
<div className='absolute top-4 right-4'>
1010
<Icon icon="arrow-up-right-from-square" />
1111
</div>
1212
<div class="vapi-badge vapi-badge-assistant">Built with Assistants</div>
1313
<br />
1414
Build a docs agent that can answer questions about your documentation
1515
</Card>
16-
<Card title="Inbound Support" icon="headset" href="/examples/inbound-support">
16+
<Card title="Inbound Support" icon="headset" href="/assistants/examples/inbound-support">
1717
<div className='absolute top-4 right-4'>
1818
<Icon icon="arrow-up-right-from-square" />
1919
</div>
2020
<div class="vapi-badge vapi-badge-assistant">Built with Assistants</div>
2121
<br />
2222
Build a technical support assistant that remembers where you left off between calls
2323
</Card>
24-
<Card title="Voice Widget" icon="microphone" href="/examples/voice-widget">
24+
<Card title="Voice Widget" icon="microphone" href="/assistants/examples/voice-widget">
2525
<div className='absolute top-4 right-4'>
2626
<Icon icon="arrow-up-right-from-square" />
2727
</div>

fern/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Explore end-to-end examples for some common voice workflows:
5858
icon="phone"
5959
iconType="solid"
6060
color="#f5ac4c"
61-
href="/examples/inbound-support"
61+
href="/assistants/examples/inbound-support"
6262
>
6363
We'll build a customer support agent that can process inbound phone calls and assist with common banking issues.
6464
</Card>

fern/quickstart/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Vapi offers two main primitives for building voice agents, each designed for dif
121121
title="Customer Support"
122122
icon="headset"
123123
iconType="solid"
124-
href="/examples/inbound-support"
124+
href="/assistants/examples/inbound-support"
125125
>
126126
<div className='absolute top-4 right-4'>
127127
<Icon icon="arrow-up-right-from-square" />

0 commit comments

Comments
 (0)