Skip to content

Commit 8df1778

Browse files
committed
Added overview for guides and examples section and split them all out
1 parent 27e8f5c commit 8df1778

File tree

7 files changed

+66
-27
lines changed

7 files changed

+66
-27
lines changed

docs/guides/examples/intro.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,6 @@ sidebarTitle: "Introduction"
44
description: "Learn how to use Trigger.dev with these practical task examples."
55
---
66

7-
| Example task | Description |
8-
| :---------------------------------------------------------------------------- | :----------------------------------------------------------------------------- |
9-
| [DALL·E 3 image generation](/guides/examples/dall-e3-generate-image) | Use OpenAI's GPT-4o and DALL·E 3 to generate an image and text. |
10-
| [FFmpeg video processing](/guides/examples/ffmpeg-video-processing) | Use FFmpeg to process a video in various ways and save it to Cloudflare R2. |
11-
| [OpenAI with retrying](/guides/examples/open-ai-with-retrying) | Create a reusable OpenAI task with custom retry options. |
12-
| [PDF to image](/guides/examples/pdf-to-image) | Use `MuPDF` to turn a PDF into images and save them to Cloudflare R2. |
13-
| [React to PDF](/guides/examples/react-pdf) | Use `react-pdf` to generate a PDF and save it to Cloudflare R2. |
14-
| [Puppeteer](/guides/examples/puppeteer) | Use Puppeteer to generate a PDF or scrape a webpage. |
15-
| [Resend email sequence](/guides/examples/resend-email-sequence) | Send a sequence of emails over several days using Resend with Trigger.dev. |
16-
| [Sharp image processing](/guides/examples/sharp-image-processing) | Use Sharp to process an image and save it to Cloudflare R2. |
17-
| [Stripe webhook](/guides/examples/stripe-webhook) | Trigger a task from Stripe webhook events. |
18-
| [Supabase database operations](/guides/examples/supabase-database-operations) | Run basic CRUD operations on a table in a Supabase database using Trigger.dev. |
19-
| [Supabase Storage upload](/guides/examples/supabase-storage-upload) | Download a video from a URL and upload it to Supabase Storage using S3. |
20-
| [Vercel AI SDK](/guides/examples/vercel-ai-sdk) | Use Vercel AI SDK to generate text using OpenAI. |
7+
import IntroExamples from "/snippets/intro-examples.mdx";
8+
9+
<IntroExamples />

docs/guides/frameworks/introduction.mdx

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,6 @@ description: "Get started with Trigger.dev in your favorite framework."
55
icon: "grid-2"
66
---
77

8-
import CardBun from "/snippets/card-bun.mdx";
9-
import CardNodejs from "/snippets/card-nodejs.mdx";
10-
import CardNextjs from "/snippets/card-nextjs.mdx";
11-
import CardRemix from "/snippets/card-remix.mdx";
12-
import CardSupabase from "/snippets/card-supabase.mdx";
8+
import IntroFrameworks from "/snippets/intro-frameworks.mdx";
139

14-
<CardGroup cols={3}>
15-
<CardBun />
16-
<CardNodejs />
17-
<CardNextjs />
18-
<CardRemix />
19-
<CardSupabase />
20-
</CardGroup>
10+
<IntroFrameworks />

docs/guides/overview.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "Frameworks, guides and examples overview"
3+
sidebarTitle: "Introduction"
4+
description: "An ever growing list of guides and examples to help you get setup with Trigger.dev."
5+
---
6+
7+
import IntroFrameworks from "/snippets/intro-frameworks.mdx";
8+
import IntroGuides from "/snippets/intro-guides.mdx";
9+
import IntroExamples from "/snippets/intro-examples.mdx";
10+
11+
## Frameworks
12+
13+
<IntroFrameworks />
14+
15+
## Guides
16+
17+
<IntroGuides />
18+
19+
## Examples
20+
21+
<IntroExamples />

docs/mint.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,10 @@
250250
"group": "Help",
251251
"pages": ["community", "help-slack", "help-email"]
252252
},
253+
{
254+
"group": "Overview",
255+
"pages": ["guides/overview"]
256+
},
253257
{
254258
"group": "Frameworks",
255259
"pages": [
@@ -265,7 +269,8 @@
265269
"pages": [
266270
"guides/frameworks/supabase-guides-overview",
267271
"guides/frameworks/supabase-edge-functions-basic",
268-
"guides/frameworks/supabase-edge-functions-database-webhooks"
272+
"guides/frameworks/supabase-edge-functions-database-webhooks",
273+
"guides/frameworks/supabase-edge-functions-ffmpeg-deepgram"
269274
]
270275
}
271276
]

docs/snippets/intro-examples.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
| Example task | Description |
2+
| :---------------------------------------------------------------------------- | :----------------------------------------------------------------------------- |
3+
| [DALL·E 3 image generation](/guides/examples/dall-e3-generate-image) | Use OpenAI's GPT-4o and DALL·E 3 to generate an image and text. |
4+
| [Deepgram audio transcription](/guides/examples/deepgram-transcribe-audio) | Transcribe audio using Deepgram's speech recognition API. |
5+
| [FFmpeg video processing](/guides/examples/ffmpeg-video-processing) | Use FFmpeg to process a video in various ways and save it to Cloudflare R2. |
6+
| [OpenAI with retrying](/guides/examples/open-ai-with-retrying) | Create a reusable OpenAI task with custom retry options. |
7+
| [PDF to image](/guides/examples/pdf-to-image) | Use `MuPDF` to turn a PDF into images and save them to Cloudflare R2. |
8+
| [React to PDF](/guides/examples/react-pdf) | Use `react-pdf` to generate a PDF and save it to Cloudflare R2. |
9+
| [Puppeteer](/guides/examples/puppeteer) | Use Puppeteer to generate a PDF or scrape a webpage. |
10+
| [Resend email sequence](/guides/examples/resend-email-sequence) | Send a sequence of emails over several days using Resend with Trigger.dev. |
11+
| [Sharp image processing](/guides/examples/sharp-image-processing) | Use Sharp to process an image and save it to Cloudflare R2. |
12+
| [Stripe webhook](/guides/examples/stripe-webhook) | Trigger a task from Stripe webhook events. |
13+
| [Supabase database operations](/guides/examples/supabase-database-operations) | Run basic CRUD operations on a table in a Supabase database using Trigger.dev. |
14+
| [Supabase Storage upload](/guides/examples/supabase-storage-upload) | Download a video from a URL and upload it to Supabase Storage using S3. |
15+
| [Vercel AI SDK](/guides/examples/vercel-ai-sdk) | Use Vercel AI SDK to generate text using OpenAI. |

docs/snippets/intro-frameworks.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import CardBun from "/snippets/card-bun.mdx";
2+
import CardNodejs from "/snippets/card-nodejs.mdx";
3+
import CardNextjs from "/snippets/card-nextjs.mdx";
4+
import CardRemix from "/snippets/card-remix.mdx";
5+
import CardSupabase from "/snippets/card-supabase.mdx";
6+
7+
<CardGroup cols={3}>
8+
<CardBun />
9+
<CardNodejs />
10+
<CardNextjs />
11+
<CardRemix />
12+
<CardSupabase />
13+
</CardGroup>

docs/snippets/intro-guides.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Get set up fast using our detailed walk-through guides.
2+
3+
| Guide | Description |
4+
| :---------------------------------------------------- | :------------------------------------------------------------------------------- |
5+
| [Prisma](/guides/frameworks/prisma) | This guide will show you how to setup Prisma with Trigger.dev |
6+
| [Sequin database triggers](/guides/frameworks/sequin) | This guide will show you how to trigger tasks from database changes using Sequin |

0 commit comments

Comments
 (0)