From b3646270e72bfba0fdbaf96a5e928caf478e6c1d Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Thu, 13 Feb 2025 17:31:56 +0000 Subject: [PATCH 1/9] typo --- docs/guides/frameworks/sveltekit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/frameworks/sveltekit.mdx b/docs/guides/frameworks/sveltekit.mdx index debd90dff1..077b62318a 100644 --- a/docs/guides/frameworks/sveltekit.mdx +++ b/docs/guides/frameworks/sveltekit.mdx @@ -7,7 +7,7 @@ icon: "s" import Prerequisites from "/snippets/framework-prerequisites.mdx"; -This is an community developed Vite plugin from [@cptCrunch_](https://x.com/cptCrunch_) that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects. +This is a community developed Vite plugin from [@cptCrunch_](https://x.com/cptCrunch_) that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects. From 3c35b3324a072672d9af562095ebc77966a6eb58 Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Thu, 13 Feb 2025 17:43:28 +0000 Subject: [PATCH 2/9] Adds feature list to the sveltekit plugin page --- docs/guides/frameworks/sveltekit.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guides/frameworks/sveltekit.mdx b/docs/guides/frameworks/sveltekit.mdx index 077b62318a..eccedb5bdd 100644 --- a/docs/guides/frameworks/sveltekit.mdx +++ b/docs/guides/frameworks/sveltekit.mdx @@ -9,6 +9,15 @@ import Prerequisites from "/snippets/framework-prerequisites.mdx"; This is a community developed Vite plugin from [@cptCrunch_](https://x.com/cptCrunch_) that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects. +## Features + +- Use SvelteKit functions directly in Trigger.dev tasks +- Automatic function discovery and export +- TypeScript support with type preservation +- Preserves JSDoc documentation +- Hot Module Reloading support +- Configurable directory scanning + ## Setup From 4b3cb5897a0bd1c14a7fa7bd6839c8d4effeeceb Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Thu, 13 Feb 2025 18:11:12 +0000 Subject: [PATCH 3/9] Removed Migrations section in side menu --- docs/docs.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index 88f29afa5e..3cc9554106 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -296,10 +296,6 @@ "guides/examples/vercel-ai-sdk", "guides/examples/vercel-sync-env-vars" ] - }, - { - "group": "Migrations", - "pages": ["guides/use-cases/upgrading-from-v2"] } ] } From 0ceeca92d449e517d2f4431ce0e38fc600aca604 Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Thu, 13 Feb 2025 18:28:45 +0000 Subject: [PATCH 4/9] Tidy up the table links --- docs/guides/introduction.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index d8e4987c63..421f90d1da 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -39,12 +39,12 @@ Get set up fast using our detailed walk-through guides. Example projects are full projects with example repos you can fork and use. These are a great way of learning how to encorporate Trigger.dev into your project. -| Example project | Description | Framework | GitHub Repo | +| Example project | Description | Framework | GitHub | | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :-------- | :---------------------------------------------------------------------------------------------------- | -| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) | -| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) | -| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) | -| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) | +| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) | +| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) | +| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) | +| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) | ## Example tasks From 02fdfa223e660d0712bb0746f727d9be606b66b5 Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Tue, 18 Feb 2025 09:14:38 +0000 Subject: [PATCH 5/9] Creates a community packages section --- docs/docs.json | 12 +++++++++++- docs/guides/community/dotenvx.mdx | 6 ++++++ docs/guides/community/fatima.mdx | 6 ++++++ docs/guides/community/rate-limiter.mdx | 10 ++++++++++ docs/guides/{frameworks => community}/sveltekit.mdx | 0 5 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/guides/community/dotenvx.mdx create mode 100644 docs/guides/community/fatima.mdx create mode 100644 docs/guides/community/rate-limiter.mdx rename docs/guides/{frameworks => community}/sveltekit.mdx (100%) diff --git a/docs/docs.json b/docs/docs.json index 3cc9554106..d090992cae 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -201,6 +201,7 @@ "dropdown": "Guides & examples", "description": "A great way to get started", "icon": "book", + "groups": [ { "group": "Introduction", @@ -213,7 +214,7 @@ "guides/frameworks/nextjs", "guides/frameworks/nodejs", "guides/frameworks/remix", - "guides/frameworks/sveltekit" + "guides/community/sveltekit" ] }, { @@ -296,6 +297,15 @@ "guides/examples/vercel-ai-sdk", "guides/examples/vercel-sync-env-vars" ] + }, + { + "group": "Community packages", + "pages": [ + "guides/community/dotenvx", + "guides/community/fatima", + "guides/community/rate-limiter", + "guides/community/sveltekit" + ] } ] } diff --git a/docs/guides/community/dotenvx.mdx b/docs/guides/community/dotenvx.mdx new file mode 100644 index 0000000000..822f61b449 --- /dev/null +++ b/docs/guides/community/dotenvx.mdx @@ -0,0 +1,6 @@ +--- +title: "dotenvx" +sidebarTitle: "dotenvx" +description: "A dotenvx for Trigger.dev." +icon: "d" +--- \ No newline at end of file diff --git a/docs/guides/community/fatima.mdx b/docs/guides/community/fatima.mdx new file mode 100644 index 0000000000..56697c652c --- /dev/null +++ b/docs/guides/community/fatima.mdx @@ -0,0 +1,6 @@ +--- +title: "Fatima" +sidebarTitle: "Fatima" +description: "A Fatima for Trigger.dev." +icon: "f" +--- diff --git a/docs/guides/community/rate-limiter.mdx b/docs/guides/community/rate-limiter.mdx new file mode 100644 index 0000000000..fc6a1bdbb2 --- /dev/null +++ b/docs/guides/community/rate-limiter.mdx @@ -0,0 +1,10 @@ +--- +title: "Rate limiter" +sidebarTitle: "Rate limiter" +description: "A rate limiter for Trigger.dev." +icon: "r" +--- + +This is a community developed package from [@ian](https://github.com/ian) that uses Redis to rate limit Trigger.dev tasks. + +[View the repo](https://github.com/ian/trigger-rate-limiting) diff --git a/docs/guides/frameworks/sveltekit.mdx b/docs/guides/community/sveltekit.mdx similarity index 100% rename from docs/guides/frameworks/sveltekit.mdx rename to docs/guides/community/sveltekit.mdx From d3d9c2194277808e569d1eaec1425efa2e9d3dba Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Tue, 18 Feb 2025 10:59:41 +0000 Subject: [PATCH 6/9] Small tweak --- docs/guides/community/rate-limiter.mdx | 2 +- docs/introduction.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/community/rate-limiter.mdx b/docs/guides/community/rate-limiter.mdx index fc6a1bdbb2..a4d5dba0fe 100644 --- a/docs/guides/community/rate-limiter.mdx +++ b/docs/guides/community/rate-limiter.mdx @@ -2,7 +2,7 @@ title: "Rate limiter" sidebarTitle: "Rate limiter" description: "A rate limiter for Trigger.dev." -icon: "r" +icon: "gauge-simple-low" --- This is a community developed package from [@ian](https://github.com/ian) that uses Redis to rate limit Trigger.dev tasks. diff --git a/docs/introduction.mdx b/docs/introduction.mdx index fd17e8b911..de4f0c078f 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -24,7 +24,7 @@ mode: "center" Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required. -We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks-regular) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure. +We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks/overview) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure. ## Learn the concepts From 0d5e1f5a91398f72ea3379dd45ff830a752991fa Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Tue, 18 Feb 2025 11:37:51 +0000 Subject: [PATCH 7/9] Adds info and links to community packages --- docs/guides/community/dotenvx.mdx | 10 +++++++--- docs/guides/community/fatima.mdx | 8 +++++++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/guides/community/dotenvx.mdx b/docs/guides/community/dotenvx.mdx index 822f61b449..01deebf389 100644 --- a/docs/guides/community/dotenvx.mdx +++ b/docs/guides/community/dotenvx.mdx @@ -1,6 +1,10 @@ --- title: "dotenvx" sidebarTitle: "dotenvx" -description: "A dotenvx for Trigger.dev." -icon: "d" ---- \ No newline at end of file +description: "A dotenvx package for Trigger.dev." +icon: "square-e" +--- + +This is a community developed package from [dotenvx](https://dotenvx.com/) that enables you to use dotenvx with Trigger.dev. + +[View the docs](https://dotenvx.com/docs/background-jobs/triggerdotdev) diff --git a/docs/guides/community/fatima.mdx b/docs/guides/community/fatima.mdx index 56697c652c..bfc517f0e2 100644 --- a/docs/guides/community/fatima.mdx +++ b/docs/guides/community/fatima.mdx @@ -1,6 +1,12 @@ --- title: "Fatima" sidebarTitle: "Fatima" -description: "A Fatima for Trigger.dev." +description: "A Fatima package for Trigger.dev." icon: "f" --- + +This is a community developed package from [@Fgc17](https://github.com/Fgc17) that enables you to use Fatima with Trigger.dev. + +[View the Fatima docs](https://fatimajs.vercel.app/docs/adapters/trigger) + +[View the repo](https://github.com/Fgc17/fatima) From 53bc0d54e9f45e93abe905e89b9a34f2730d8dbc Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Tue, 18 Feb 2025 13:07:14 +0000 Subject: [PATCH 8/9] Updated mintlify broken links version in workflow file --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3abe5cb4fe..bef575c353 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,4 +39,4 @@ jobs: ${{ runner.os }}-mintlify - name: 🔗 Check for broken links - run: npx mintlify@4.0.222 broken-links + run: npx mintlify@4.0.393 broken-links From 25007b746bfaf09dd10a1c7efc976a083d14bb59 Mon Sep 17 00:00:00 2001 From: James Ritchie Date: Tue, 18 Feb 2025 13:07:23 +0000 Subject: [PATCH 9/9] fixed broken link --- docs/guides/introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index 421f90d1da..31e9bda6fd 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -12,7 +12,7 @@ mode: "center" - +