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 diff --git a/docs/docs.json b/docs/docs.json index 88f29afa5e..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" ] }, { @@ -298,8 +299,13 @@ ] }, { - "group": "Migrations", - "pages": ["guides/use-cases/upgrading-from-v2"] + "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..01deebf389 --- /dev/null +++ b/docs/guides/community/dotenvx.mdx @@ -0,0 +1,10 @@ +--- +title: "dotenvx" +sidebarTitle: "dotenvx" +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 new file mode 100644 index 0000000000..bfc517f0e2 --- /dev/null +++ b/docs/guides/community/fatima.mdx @@ -0,0 +1,12 @@ +--- +title: "Fatima" +sidebarTitle: "Fatima" +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) diff --git a/docs/guides/community/rate-limiter.mdx b/docs/guides/community/rate-limiter.mdx new file mode 100644 index 0000000000..a4d5dba0fe --- /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: "gauge-simple-low" +--- + +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/community/sveltekit.mdx b/docs/guides/community/sveltekit.mdx new file mode 100644 index 0000000000..eccedb5bdd --- /dev/null +++ b/docs/guides/community/sveltekit.mdx @@ -0,0 +1,31 @@ +--- +title: "SvelteKit setup guide" +sidebarTitle: "SvelteKit" +description: "A plugin for SvelteKit to integrate with Trigger.dev." +icon: "s" +--- + +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 + +[View setup guide on npm](https://www.npmjs.com/package/vite-plugin-triggerkit) + +```bash +npm i vite-plugin-triggerkit +``` + + diff --git a/docs/guides/frameworks/sveltekit.mdx b/docs/guides/frameworks/sveltekit.mdx deleted file mode 100644 index debd90dff1..0000000000 --- a/docs/guides/frameworks/sveltekit.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "SvelteKit setup guide" -sidebarTitle: "SvelteKit" -description: "A plugin for SvelteKit to integrate with Trigger.dev." -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. - - - -## Setup - -[View setup guide on npm](https://www.npmjs.com/package/vite-plugin-triggerkit) - -```bash -npm i vite-plugin-triggerkit -``` - - diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index d8e4987c63..31e9bda6fd 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -12,7 +12,7 @@ mode: "center" - + @@ -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 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