github-featured/triggerdotdev--trigger.dev
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

Added guides and examples links and snippet

Browse Source
This commit is contained in:
D-K-P
2025-02-03 14:30:03 +00:00
parent b377b577ca
commit d285f7930e
5 changed files with 58 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/examples.mdx
+8
View File
@@ -0,0 +1,8 @@
---
title: "Guides & examples"
description: "Ready-to-use examples to help you get started with Trigger.dev."
---
import ExamplesCards from "/snippets/examples-cards.mdx";
<ExamplesCards />
docs/introduction.mdx
+5 -1
View File
@@ -18,6 +18,8 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
## Getting started
### Video walkthrough
<div className="w-full h-full aspect-video mb-3">
<iframe
width="100%"
@@ -30,6 +32,8 @@ We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can ch
/>
</div>
### Quick start, writing tasks and guides
<CardGroup>
<Card title="Quick start guide" icon="person-running-fast" href="/quick-start">
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
</Card>
<Card title="Example tasks" icon="code" href="/guides/introduction#example-tasks">
Code you can use in your own projects, including OpenAI, Deepgram, FFmpeg, Puppeteer, Stripe,
Supabase and more.
Supabase and many more.
</Card>
</CardGroup>
docs/mint.json
+2 -1
View File
@@ -177,7 +177,8 @@
"runs/metadata",
"run-usage",
"context",
"bulk-actions"
"bulk-actions",
"examples"
]
},
{
docs/snippets/examples-cards.mdx
+20
View File
@@ -0,0 +1,20 @@
## Our library of examples, guides and projects
<CardGroup cols={2}>
<Card title="Walkthrough guides" icon="book" href="/guides/introduction">
Detailed guides for setting up Trigger.dev with popular frameworks and services, including
Next.js, Remix, Supabase, Stripe and more.
</Card>
<Card title="Example tasks" icon="code" href="/guides/introduction#example-tasks">
Task code you can copy and paste to use in your own projects, including OpenAI, Vercel AI SDK,
Deepgram, FFmpeg, Puppeteer, Stripe, Supabase and more.
</Card>
<Card title="Webhook guides" icon="code" href="/guides/frameworks/webhooks-guides-overview">
Learn how to trigger tasks from webhooks, including Next.js, Remix, Supabase and Stripe and
more.
</Card>
<Card title="Example projects" icon="GitHub" href="/guides/introduction#example-projects">
Full-stack projects demonstrating how to use Trigger.dev. Fork them in GitHub as a starting
point for your own projects.
</Card>
</CardGroup>
docs/writing-tasks-introduction.mdx
+23 -13
View File
@@ -1,21 +1,31 @@
---
title: "Writing tasks: Introduction"
sidebarTitle: "Introduction"
title: "Writing tasks: Overview"
sidebarTitle: "Overview"
description: "Tasks are the core of Trigger.dev. They are long-running processes that are triggered by events."
---
import ExamplesCards from "/snippets/examples-cards.mdx";
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.
## Writing tasks
| Topic | Description |
| :---------------------------------------------------| :------------------------------------------------------------------------------------------------------------------------ |
| [Logging](/logging) | View and send logs and traces from your tasks. |
| [Errors & retrying](/errors-retrying) | How to deal with errors and write reliable tasks. |
| [Wait](/wait) | Wait for periods of time or for external events to occur before continuing. |
| [Concurrency & Queues](/queue-concurrency) | Configure what you want to happen when there is more than one run at a time. |
| [Versioning](/versioning) | How versioning works. |
| [Machines](/machines) | Configure the CPU and RAM of the machine your task runs on |
| [Idempotency](/idempotency) | Protect against mutations happening twice. |
| [Replaying](/replaying) | You can replay a single task or many at once with a new version of your code. |
| [Notifications](/notifications) | Send realtime notifications from your task that you can subscribe to from your backend or frontend. |
| Topic | Description |
| :------------------------------------------- | :-------------------------------------------------------------------------------------------------- |
| [Logging](/logging) | View and send logs and traces from your tasks. |
| [Errors & retrying](/errors-retrying) | How to deal with errors and write reliable tasks. |
| [Wait](/wait) | Wait for periods of time or for external events to occur before continuing. |
| [Concurrency & Queues](/queue-concurrency) | Configure what you want to happen when there is more than one run at a time. |
| [Realtime notifications](/realtime/overview) | Send realtime notifications from your task that you can subscribe to from your backend or frontend. |
| [Versioning](/versioning) | How versioning works. |
| [Machines](/machines) | Configure the CPU and RAM of the machine your task runs on |
| [Idempotency](/idempotency) | Protect against mutations happening twice. |
| [Replaying](/replaying) | You can replay a single task or many at once with a new version of your code. |
| [Max duration](/runs/max-duration) | Set a maximum duration for your task to run. |
| [Tags](/tags) | Tags allow you to easily filter runs in the dashboard and when using the SDK. |
| [Metadata](/runs/metadata) | Attach a small amount of data to a run and update it as the run progresses. |
| [Usage](/run-usage) | Get compute duration and cost from inside a run, or for a specific block of code. |
| [Context](/context) | Access the context of the task run. |
| [Bulk actions](/bulk-actions) | Run actions on many task runs at once. |
<ExamplesCards />