Skip to content

Commit e46e9bd

Browse files
authored
docs: Manual setup guide (#2358)
* Add manual monorepo setup guide for Trigger.dev This commit introduces a new "Manual setup" guide for setting up Trigger.dev in projects, specifically focused on monorepo configurations. The guide outlines two primary approaches for monorepos: creating a dedicated tasks package and integrating tasks directly within apps. This detailed documentation aims to help developers manually configure their projects, bypassing automated steps, and understanding the setup better. - Provides step-by-step instructions for both 'Tasks as a package' and 'Tasks in apps' approaches. - Includes example configurations for various package managers, environment setups, and runtime options. - Enhances user understanding of Trigger.dev's configuration requirements in complex monorepo environments. The purpose of adding this guide is to enable developers to seamlessly integrate Trigger.dev into their monorepos, whether they choose to abstract tasks into packages or embed them within individual applications. This flexibility supports diverse project structures while maintaining consistency with Trigger.dev's operational prerequisites. * Correct tasks usage in documentation The 'tasks as package' section in the documentation had an incorrect example under 'Use tasks in your apps' which needed correction to align with the actual package usage. - Fixed incorrect import of tasks by updating to the correct import from '@repo/tasks/trigger'. - Updated the syntax to use 'tasks.trigger' with type parameters, following the new pattern established for triggering tasks with TypeScript. - Added error handling to catch and log errors during task execution, returning a meaningful error message instead of just failing silently. This update ensures developers have an accurate reference when implementing tasks in their applications, especially given the breaking changes in TypeScript compatibility due to recent package updates. * Update package configuration for Zod 3-4 compatibility The recent Zod package updates from version 3 to 4 introduce breaking changes in TypeScript compatibility that require adjustments in our project configuration files. The primary updates involve adding type annotations and modifying import statements to support the shift without breaking existing functionality. - Updated `package.json` and initialization files to align with new compatibility requirements. - Modified server task examples to explicitly use type imports for improved error handling and consistency. - Adjusted workspace and project settings to maintain compatibility and improve configuration clarity. - Provided references to current examples for better implementation guidance. * More manual setup guide steps * Fix bun docs link
1 parent 3cd7dd8 commit e46e9bd

File tree

2 files changed

+696
-17
lines changed

2 files changed

+696
-17
lines changed

docs/docs.json

Lines changed: 65 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010
},
1111
"favicon": "/images/favicon.png",
1212
"contextual": {
13-
"options": ["copy", "view", "claude"]
13+
"options": [
14+
"copy",
15+
"view",
16+
"claude"
17+
]
1418
},
1519
"navigation": {
1620
"dropdowns": [
@@ -24,6 +28,7 @@
2428
"pages": [
2529
"introduction",
2630
"quick-start",
31+
"manual-setup",
2732
"video-walkthrough",
2833
"how-it-works",
2934
"limits",
@@ -35,7 +40,11 @@
3540
"pages": [
3641
{
3742
"group": "Tasks",
38-
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
43+
"pages": [
44+
"tasks/overview",
45+
"tasks/schemaTask",
46+
"tasks/scheduled"
47+
]
3948
},
4049
"triggering",
4150
"runs",
@@ -50,7 +59,12 @@
5059
"errors-retrying",
5160
{
5261
"group": "Wait",
53-
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
62+
"pages": [
63+
"wait",
64+
"wait-for",
65+
"wait-until",
66+
"wait-for-token"
67+
]
5468
},
5569
"queue-concurrency",
5670
"versioning",
@@ -96,7 +110,9 @@
96110
},
97111
{
98112
"group": "Development",
99-
"pages": ["cli-dev"]
113+
"pages": [
114+
"cli-dev"
115+
]
100116
},
101117
{
102118
"group": "Deployment",
@@ -108,7 +124,9 @@
108124
"deployment/atomic-deployment",
109125
{
110126
"group": "Deployment integrations",
111-
"pages": ["vercel-integration"]
127+
"pages": [
128+
"vercel-integration"
129+
]
112130
}
113131
]
114132
},
@@ -161,7 +179,12 @@
161179
},
162180
{
163181
"group": "Using the Dashboard",
164-
"pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
182+
"pages": [
183+
"run-tests",
184+
"troubleshooting-alerts",
185+
"replaying",
186+
"bulk-actions"
187+
]
165188
},
166189
{
167190
"group": "Troubleshooting",
@@ -183,23 +206,39 @@
183206
"self-hosting/kubernetes",
184207
{
185208
"group": "Environment variables",
186-
"pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
209+
"pages": [
210+
"self-hosting/env/webapp",
211+
"self-hosting/env/supervisor"
212+
]
187213
}
188214
],
189-
"tags": ["v4"],
215+
"tags": [
216+
"v4"
217+
],
190218
"tag": "v4"
191219
},
192220
{
193221
"group": "Self-hosting",
194-
"pages": ["open-source-self-hosting"]
222+
"pages": [
223+
"open-source-self-hosting"
224+
]
195225
},
196226
{
197227
"group": "Open source",
198-
"pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
228+
"pages": [
229+
"open-source-contributing",
230+
"github-repo",
231+
"changelog",
232+
"roadmap"
233+
]
199234
},
200235
{
201236
"group": "Help",
202-
"pages": ["community", "help-slack", "help-email"]
237+
"pages": [
238+
"community",
239+
"help-slack",
240+
"help-email"
241+
]
203242
}
204243
]
205244
},
@@ -220,7 +259,10 @@
220259
},
221260
{
222261
"group": "Tasks API",
223-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
262+
"pages": [
263+
"management/tasks/trigger",
264+
"management/tasks/batch-trigger"
265+
]
224266
},
225267
{
226268
"group": "Runs API",
@@ -266,7 +308,9 @@
266308
"groups": [
267309
{
268310
"group": "Introduction",
269-
"pages": ["guides/introduction"]
311+
"pages": [
312+
"guides/introduction"
313+
]
270314
},
271315
{
272316
"group": "Frameworks",
@@ -328,7 +372,6 @@
328372
}
329373
]
330374
},
331-
332375
{
333376
"group": "Example projects",
334377
"pages": [
@@ -384,7 +427,9 @@
384427
},
385428
{
386429
"group": "Migration guides",
387-
"pages": ["migration-mergent"]
430+
"pages": [
431+
"migration-mergent"
432+
]
388433
},
389434
{
390435
"group": "Community packages",
@@ -405,7 +450,10 @@
405450
"href": "https://trigger.dev"
406451
},
407452
"api": {
408-
"openapi": ["openapi.yml", "v3-openapi.yaml"],
453+
"openapi": [
454+
"openapi.yml",
455+
"v3-openapi.yaml"
456+
],
409457
"playground": {
410458
"display": "simple"
411459
}
@@ -580,4 +628,4 @@
580628
"destination": "/management/overview"
581629
}
582630
]
583-
}
631+
}

0 commit comments

Comments
 (0)