Skip to content

Commit d285f79

Browse files
committed
Added guides and examples links and snippet
1 parent b377b57 commit d285f79

File tree

5 files changed

+58
-15
lines changed

5 files changed

+58
-15
lines changed

docs/examples.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Guides & examples"
3+
description: "Ready-to-use examples to help you get started with Trigger.dev."
4+
---
5+
6+
import ExamplesCards from "/snippets/examples-cards.mdx";
7+
8+
<ExamplesCards />

docs/introduction.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
1818

1919
## Getting started
2020

21+
### Video walkthrough
22+
2123
<div className="w-full h-full aspect-video mb-3">
2224
<iframe
2325
width="100%"
@@ -30,6 +32,8 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
3032
/>
3133
</div>
3234

35+
### Quick start, writing tasks and guides
36+
3337
<CardGroup>
3438
<Card title="Quick start guide" icon="person-running-fast" href="/quick-start">
3539
Go from zero to running your first task in 3 minutes.
@@ -43,7 +47,7 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
4347
</Card>
4448
<Card title="Example tasks" icon="code" href="/guides/introduction#example-tasks">
4549
Code you can use in your own projects, including OpenAI, Deepgram, FFmpeg, Puppeteer, Stripe,
46-
Supabase and more.
50+
Supabase and many more.
4751
</Card>
4852
</CardGroup>
4953

docs/mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@
177177
"runs/metadata",
178178
"run-usage",
179179
"context",
180-
"bulk-actions"
180+
"bulk-actions",
181+
"examples"
181182
]
182183
},
183184
{

docs/snippets/examples-cards.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Our library of examples, guides and projects
2+
3+
<CardGroup cols={2}>
4+
<Card title="Walkthrough guides" icon="book" href="/guides/introduction">
5+
Detailed guides for setting up Trigger.dev with popular frameworks and services, including
6+
Next.js, Remix, Supabase, Stripe and more.
7+
</Card>
8+
<Card title="Example tasks" icon="code" href="/guides/introduction#example-tasks">
9+
Task code you can copy and paste to use in your own projects, including OpenAI, Vercel AI SDK,
10+
Deepgram, FFmpeg, Puppeteer, Stripe, Supabase and more.
11+
</Card>
12+
<Card title="Webhook guides" icon="code" href="/guides/frameworks/webhooks-guides-overview">
13+
Learn how to trigger tasks from webhooks, including Next.js, Remix, Supabase and Stripe and
14+
more.
15+
</Card>
16+
<Card title="Example projects" icon="GitHub" href="/guides/introduction#example-projects">
17+
Full-stack projects demonstrating how to use Trigger.dev. Fork them in GitHub as a starting
18+
point for your own projects.
19+
</Card>
20+
</CardGroup>

docs/writing-tasks-introduction.mdx

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
11
---
2-
title: "Writing tasks: Introduction"
3-
sidebarTitle: "Introduction"
2+
title: "Writing tasks: Overview"
3+
sidebarTitle: "Overview"
44
description: "Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events."
55
---
66

7+
import ExamplesCards from "/snippets/examples-cards.mdx";
8+
79
Before digging deeper into the details of writing tasks, you should read the [fundamentals of tasks](/tasks/overview) to understand what tasks are and how they work.
810

911
## Writing tasks
1012

11-
| Topic | Description |
12-
| :---------------------------------------------------| :------------------------------------------------------------------------------------------------------------------------ |
13-
| [Logging](/logging) | View and send logs and traces from your tasks. |
14-
| [Errors & retrying](/errors-retrying) | How to deal with errors and write reliable tasks. |
15-
| [Wait](/wait) | Wait for periods of time or for external events to occur before continuing. |
16-
| [Concurrency & Queues](/queue-concurrency) | Configure what you want to happen when there is more than one run at a time. |
17-
| [Versioning](/versioning) | How versioning works. |
18-
| [Machines](/machines) | Configure the CPU and RAM of the machine your task runs on |
19-
| [Idempotency](/idempotency) | Protect against mutations happening twice. |
20-
| [Replaying](/replaying) | You can replay a single task or many at once with a new version of your code. |
21-
| [Notifications](/notifications) | Send realtime notifications from your task that you can subscribe to from your backend or frontend. |
13+
| Topic | Description |
14+
| :------------------------------------------- | :-------------------------------------------------------------------------------------------------- |
15+
| [Logging](/logging) | View and send logs and traces from your tasks. |
16+
| [Errors & retrying](/errors-retrying) | How to deal with errors and write reliable tasks. |
17+
| [Wait](/wait) | Wait for periods of time or for external events to occur before continuing. |
18+
| [Concurrency & Queues](/queue-concurrency) | Configure what you want to happen when there is more than one run at a time. |
19+
| [Realtime notifications](/realtime/overview) | Send realtime notifications from your task that you can subscribe to from your backend or frontend. |
20+
| [Versioning](/versioning) | How versioning works. |
21+
| [Machines](/machines) | Configure the CPU and RAM of the machine your task runs on |
22+
| [Idempotency](/idempotency) | Protect against mutations happening twice. |
23+
| [Replaying](/replaying) | You can replay a single task or many at once with a new version of your code. |
24+
| [Max duration](/runs/max-duration) | Set a maximum duration for your task to run. |
25+
| [Tags](/tags) | Tags allow you to easily filter runs in the dashboard and when using the SDK. |
26+
| [Metadata](/runs/metadata) | Attach a small amount of data to a run and update it as the run progresses. |
27+
| [Usage](/run-usage) | Get compute duration and cost from inside a run, or for a specific block of code. |
28+
| [Context](/context) | Access the context of the task run. |
29+
| [Bulk actions](/bulk-actions) | Run actions on many task runs at once. |
30+
31+
<ExamplesCards />

0 commit comments

Comments
 (0)