Minor tweaks and moved bun

D-K-P · D-K-P · commit 22fa84ea5669 · 2024-09-18T10:44:37.000+01:00
diff --git a/docs/examples/dall-e3-generate-image.mdx b/docs/examples/dall-e3-generate-image.mdx
@@ -65,9 +65,9 @@ function generateImagePrompt(theme: string, description: string): any {
 }
 ```
 
-## Testing
+## Testing your task
 
-To test this task, you can use the following payload:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
diff --git a/docs/examples/ffmpeg-video-processing.mdx b/docs/examples/ffmpeg-video-processing.mdx
@@ -349,9 +349,9 @@ export const ffmpegGenerateThumbnail = task({
 });
 ```
 
-### Testing:
+## Testing your task
 
-To test this task, use this payload structure:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
diff --git a/docs/examples/intro.mdx b/docs/examples/intro.mdx
@@ -4,12 +4,12 @@ sidebarTitle: "Introduction"
 description: "Learn how to use Trigger.dev with these practical task examples."
 ---
 
-| Example task                                                       | Description                                                                |
-| :----------------------------------------------------------------- | :------------------------------------------------------------------------- |
-| [DALL·E 3 image generation](/examples/generate-image-with-dall-e3) | Use OpenAI's GPT-4o and DALL·E 3 to generate an image and text.            |
-| [FFmpeg video processing](/examples/ffmpeg-video-processing)       | Use FFmpeg to process a video and save it to Cloudflare R2.                |
-| [OpenAI with retrying](/examples/open-ai-with-retrying)            | Create a reusable OpenAI task with custom retry options.                   |
-| [React to PDF](/examples/react-pdf)                                | Use `react-pdf` to generate a PDF and save it to Cloudflare R2.            |
-| [Resend email sequence](/examples/resend-email-sequence)           | Send a sequence of emails over several days using Resend with Trigger.dev. |
-| [Sharp image processing](/examples/sharp-image-processing)         | Use Sharp to process an image and save it to Cloudflare R2.                |
-| [Vercel AI SDK](/examples/vercel-ai-sdk)                           | Use Vercel AI SDK to generate text using OpenAI.                           |
+| Example task                                                       | Description                                                                 |
+| :----------------------------------------------------------------- | :-------------------------------------------------------------------------- |
+| [DALL·E 3 image generation](/examples/generate-image-with-dall-e3) | Use OpenAI's GPT-4o and DALL·E 3 to generate an image and text.             |
+| [FFmpeg video processing](/examples/ffmpeg-video-processing)       | Use FFmpeg to process a video in various ways and save it to Cloudflare R2. |
+| [OpenAI with retrying](/examples/open-ai-with-retrying)            | Create a reusable OpenAI task with custom retry options.                    |
+| [React to PDF](/examples/react-pdf)                                | Use `react-pdf` to generate a PDF and save it to Cloudflare R2.             |
+| [Resend email sequence](/examples/resend-email-sequence)           | Send a sequence of emails over several days using Resend with Trigger.dev.  |
+| [Sharp image processing](/examples/sharp-image-processing)         | Use Sharp to process an image and save it to Cloudflare R2.                 |
+| [Vercel AI SDK](/examples/vercel-ai-sdk)                           | Use Vercel AI SDK to generate text using OpenAI.                            |
diff --git a/docs/examples/open-ai-with-retrying.mdx b/docs/examples/open-ai-with-retrying.mdx
@@ -45,9 +45,9 @@ export const openaiTask = task({
 });
 ```
 
-## Testing
+## Testing your task
 
-To test this task, you can use the following payload:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
diff --git a/docs/examples/react-pdf.mdx b/docs/examples/react-pdf.mdx
@@ -74,9 +74,9 @@ export const generateResumePDF = task({
 });
 ```
 
-### Testing
+## Testing your task
 
-To test this task, you can use the following payload:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
diff --git a/docs/examples/resend-email-sequence.mdx b/docs/examples/resend-email-sequence.mdx
@@ -22,7 +22,7 @@ export const emailSequence = task({
   run: async (payload: { userId: string; email: string; name: string }) => {
     console.log(`Start email sequence for user ${payload.userId}`, payload);
 
-    //send the first email immediately
+    // Send the first email immediately
     const firstEmailResult = await retry.onThrow(
       async ({ attempt }) => {
         const { data, error } = await resend.emails.send({
@@ -33,7 +33,7 @@ export const emailSequence = task({
         });
 
         if (error) {
-          //throwing an error will trigger a retry of this block
+          // Throwing an error will trigger a retry of this block
           throw error;
         }
 
@@ -42,10 +42,10 @@ export const emailSequence = task({
       { maxAttempts: 3 }
     );
 
-    //then wait 3 days
+    // Then wait 3 days
     await wait.for({ days: 3 });
 
-    //send the second email
+    // Send the second email
     const secondEmailResult = await retry.onThrow(
       async ({ attempt }) => {
         const { data, error } = await resend.emails.send({
@@ -56,7 +56,7 @@ export const emailSequence = task({
         });
 
         if (error) {
-          //throwing an error will trigger a retry of this block
+          // Throwing an error will trigger a retry of this block
           throw error;
         }
 
@@ -70,15 +70,14 @@ export const emailSequence = task({
 });
 ```
 
-### Testing
+## Testing your task
 
-To test this task, you can use the following payload:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
   "userId": "123",
-  // Replace with your test email
-  "email": "<your-test-email>",
+  "email": "<your-test-email>", // Replace with your test email
   "name": "Alice Testington"
 }
 ```
diff --git a/docs/examples/sharp-image-processing.mdx b/docs/examples/sharp-image-processing.mdx
@@ -120,13 +120,13 @@ export const sharpProcessImage = task({
 });
 ```
 
-### Testing
+## Testing your task
 
-To test this task, use this payload structure:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
-  "imageUrl": "<an-image-url.jpg>",
-  "watermarkUrl": "<an-image-url.png>"
+  "imageUrl": "<an-image-url.jpg>", // Replace with a URL to a JPEG image
+  "watermarkUrl": "<an-image-url.png>" // Replace with a URL to a PNG watermark image
 }
 ```
diff --git a/docs/examples/vercel-ai-sdk.mdx b/docs/examples/vercel-ai-sdk.mdx
@@ -42,9 +42,9 @@ export const openaiTask = task({
 });
 ```
 
-### Testing
+## Testing your task
 
-To test this task, you can use the following payload:
+To test this task in the dashboard, you can use the following payload:
 
 ```json
 {
diff --git a/docs/guides/frameworks/bun.mdx b/docs/guides/frameworks/bun.mdx
diff --git a/docs/mint.json b/docs/mint.json
@@ -247,7 +247,7 @@
       "pages": [
         "guides/frameworks/introduction",
         "guides/frameworks/nodejs",
-        "guides/bun",
+        "guides/frameworks/bun",
         "guides/frameworks/nextjs",
         "guides/frameworks/remix",
         {

Original file line number	Diff line number	Diff line change
`@@ -65,9 +65,9 @@ function generateImagePrompt(theme: string, description: string): any {`
`65`	`65`	`}`
`66`	`66`	```
`67`	`67`
`68`		`-## Testing`
	`68`	`+## Testing your task`
`69`	`69`
`70`		`-To test this task, you can use the following payload:`
	`70`	`+To test this task in the dashboard, you can use the following payload:`
`71`	`71`
`72`	`72`	```json
`73`	`73`	`{`
Original file line number	Diff line number	Diff line change
`@@ -349,9 +349,9 @@ export const ffmpegGenerateThumbnail = task({`
`349`	`349`	`});`
`350`	`350`	```
`351`	`351`
`352`		`-### Testing:`
	`352`	`+## Testing your task`
`353`	`353`
`354`		`-To test this task, use this payload structure:`
	`354`	`+To test this task in the dashboard, you can use the following payload:`
`355`	`355`
`356`	`356`	```json
`357`	`357`	`{`
Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,9 @@ export const openaiTask = task({`
`45`	`45`	`});`
`46`	`46`	```
`47`	`47`
`48`		`-## Testing`
	`48`	`+## Testing your task`
`49`	`49`
`50`		`-To test this task, you can use the following payload:`
	`50`	`+To test this task in the dashboard, you can use the following payload:`
`51`	`51`
`52`	`52`	```json
`53`	`53`	`{`
Original file line number	Diff line number	Diff line change
`@@ -74,9 +74,9 @@ export const generateResumePDF = task({`
`74`	`74`	`});`
`75`	`75`	```
`76`	`76`
`77`		`-### Testing`
	`77`	`+## Testing your task`
`78`	`78`
`79`		`-To test this task, you can use the following payload:`
	`79`	`+To test this task in the dashboard, you can use the following payload:`
`80`	`80`
`81`	`81`	```json
`82`	`82`	`{`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,9 @@ export const openaiTask = task({`
`42`	`42`	`});`
`43`	`43`	```
`44`	`44`
`45`		`-### Testing`
	`45`	`+## Testing your task`
`46`	`46`
`47`		`-To test this task, you can use the following payload:`
	`47`	`+To test this task in the dashboard, you can use the following payload:`
`48`	`48`
`49`	`49`	```json
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@`
`247`	`247`	`"pages": [`
`248`	`248`	`"guides/frameworks/introduction",`
`249`	`249`	`"guides/frameworks/nodejs",`
`250`		`- "guides/bun",`
	`250`	`+ "guides/frameworks/bun",`
`251`	`251`	`"guides/frameworks/nextjs",`
`252`	`252`	`"guides/frameworks/remix",`
`253`	`253`	`{`