Skip to content

Commit a696359

Browse files
samejrD-K-P
samejr
and
D-K-P
authored
Update docs theme (#1189)
* Changed theme to venus and updated primary colours * Replaced ‘v3 (Developer Preview)’ with ‘v3’ * Removed webhooks and zod from tasks overview and intro * pnpm lock * Changed the theme and background + removed the tabs --------- Co-authored-by: D-K-P <[email protected]>
1 parent 52b6f48 commit a696359

File tree

4 files changed

+3518
-3125
lines changed

4 files changed

+3518
-3125
lines changed

‎docs/mint.json

Lines changed: 41 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
{
22
"$schema": "https://mintlify.com/schema.json",
33
"name": "Trigger.dev",
4-
"openapi": [
5-
"/openapi.yml",
6-
"/v3-openapi.yaml"
7-
],
8-
"versions": [
9-
"v3 (Developer Preview)",
10-
"v2"
11-
],
4+
"openapi": ["/openapi.yml", "/v3-openapi.yaml"],
5+
"versions": ["v3", "v2"],
126
"api": {
137
"playground": {
148
"mode": "simple"
@@ -22,15 +16,20 @@
2216
},
2317
"favicon": "/images/favicon.png",
2418
"colors": {
25-
"primary": "#818cf8",
26-
"light": "#818cf8",
27-
"dark": "#818cf8",
19+
"primary": "#A8FF53",
20+
"light": "#A8FF53",
21+
"dark": "#A8FF53",
2822
"anchors": {
2923
"from": "#fff",
3024
"to": "#eee"
25+
},
26+
"background": {
27+
"light": "#fff",
28+
"dark": "#121317"
3129
}
3230
},
33-
"backgroundImage": "/images/docs-background.png",
31+
"theme": "quill",
32+
3433
"modeToggle": {
3534
"default": "dark",
3635
"isHidden": true
@@ -50,36 +49,7 @@
5049
"url": "https://discord.gg/kA47vcd8P6"
5150
}
5251
],
53-
"primaryTab": {
54-
"name": "Home"
55-
},
56-
"tabs": [
57-
{
58-
"name": "Integrations",
59-
"url": "integrations",
60-
"version": "v2"
61-
},
62-
{
63-
"name": "Reference",
64-
"url": "sdk",
65-
"version": "v2"
66-
},
67-
{
68-
"name": "Examples",
69-
"url": "https://trigger.dev/apis",
70-
"version": "v2"
71-
},
72-
{
73-
"name": "v3 Developer Preview",
74-
"url": "https://trigger.dev/docs/v3",
75-
"version": "v2"
76-
},
77-
{
78-
"name": "v2",
79-
"url": "https://trigger.dev/docs/documentation",
80-
"version": "v3 (Developer Preview)"
81-
}
82-
],
52+
8353
"redirects": [
8454
{
8555
"source": "/documentation/quickstart",
@@ -101,14 +71,12 @@
10171
"navigation": [
10272
{
10373
"group": "",
104-
"version": "v3 (Developer Preview)",
105-
"pages": [
106-
"v3/introduction"
107-
]
74+
"version": "v3",
75+
"pages": ["v3/introduction"]
10876
},
10977
{
11078
"group": "Getting Started",
111-
"version": "v3 (Developer Preview)",
79+
"version": "v3",
11280
"pages": [
11381
"v3/quick-start",
11482
"v3/upgrading-from-v2",
@@ -119,48 +87,40 @@
11987
},
12088
{
12189
"group": "Fundamentals",
122-
"version": "v3 (Developer Preview)",
90+
"version": "v3",
12391
"pages": [
12492
"v3/trigger-folder",
12593
"v3/tasks-overview",
12694
"v3/triggering",
12795
"v3/apikeys",
12896
{
12997
"group": "Task types",
130-
"pages": [
131-
"v3/tasks-regular",
132-
"v3/tasks-scheduled"
133-
]
98+
"pages": ["v3/tasks-regular", "v3/tasks-scheduled"]
13499
},
135100
"v3/trigger-config"
136101
]
137102
},
138103
{
139104
"group": "Development",
140-
"version": "v3 (Developer Preview)",
141-
"pages": [
142-
"v3/cli-dev",
143-
"v3/run-tests"
144-
]
105+
"version": "v3",
106+
"pages": ["v3/cli-dev", "v3/run-tests"]
145107
},
146108
{
147109
"group": "Deployment",
148-
"version": "v3 (Developer Preview)",
110+
"version": "v3",
149111
"pages": [
150112
"v3/deploy-environment-variables",
151113
"v3/cli-deploy",
152114
"v3/github-actions",
153115
{
154116
"group": "Deployment integrations",
155-
"pages": [
156-
"v3/vercel-integration"
157-
]
117+
"pages": ["v3/vercel-integration"]
158118
}
159119
]
160120
},
161121
{
162122
"group": "Writing tasks",
163-
"version": "v3 (Developer Preview)",
123+
"version": "v3",
164124
"pages": [
165125
"v3/writing-tasks-introduction",
166126
"v3/logging",
@@ -185,15 +145,12 @@
185145
},
186146
{
187147
"group": "API reference",
188-
"version": "v3 (Developer Preview)",
148+
"version": "v3",
189149
"pages": [
190150
"v3/management/overview",
191151
{
192152
"group": "Tasks API",
193-
"pages": [
194-
"v3/management/tasks/trigger",
195-
"v3/management/tasks/batch-trigger"
196-
]
153+
"pages": ["v3/management/tasks/trigger", "v3/management/tasks/batch-trigger"]
197154
},
198155
{
199156
"group": "Runs API",
@@ -230,24 +187,18 @@
230187
},
231188
{
232189
"group": "Projects API",
233-
"pages": [
234-
"v3/management/projects/runs"
235-
]
190+
"pages": ["v3/management/projects/runs"]
236191
}
237192
]
238193
},
239194
{
240195
"group": "Open source",
241-
"version": "v3 (Developer Preview)",
242-
"pages": [
243-
"v3/github-repo",
244-
"v3/open-source-self-hosting",
245-
"v3/open-source-contributing"
246-
]
196+
"version": "v3",
197+
"pages": ["v3/github-repo", "v3/open-source-self-hosting", "v3/open-source-contributing"]
247198
},
248199
{
249200
"group": "Troubleshooting",
250-
"version": "v3 (Developer Preview)",
201+
"version": "v3",
251202
"pages": [
252203
"v3/troubleshooting",
253204
"v3/troubleshooting-alerts",
@@ -258,12 +209,8 @@
258209
},
259210
{
260211
"group": "Help",
261-
"version": "v3 (Developer Preview)",
262-
"pages": [
263-
"v3/community",
264-
"v3/help-slack",
265-
"v3/help-email"
266-
]
212+
"version": "v3",
213+
"pages": ["v3/community", "v3/help-slack", "v3/help-email"]
267214
},
268215
{
269216
"group": "Getting Started",
@@ -455,10 +402,7 @@
455402
"pages": [
456403
{
457404
"group": "Airtable",
458-
"pages": [
459-
"integrations/apis/airtable",
460-
"integrations/apis/airtable-tasks"
461-
]
405+
"pages": ["integrations/apis/airtable", "integrations/apis/airtable-tasks"]
462406
},
463407
{
464408
"group": "GitHub",
@@ -484,25 +428,16 @@
484428
},
485429
{
486430
"group": "Plain",
487-
"pages": [
488-
"integrations/apis/plain",
489-
"integrations/apis/plain-tasks"
490-
]
431+
"pages": ["integrations/apis/plain", "integrations/apis/plain-tasks"]
491432
},
492433
"integrations/apis/replicate",
493434
{
494435
"group": "SendGrid",
495-
"pages": [
496-
"integrations/apis/sendgrid",
497-
"integrations/apis/sendgrid-tasks"
498-
]
436+
"pages": ["integrations/apis/sendgrid", "integrations/apis/sendgrid-tasks"]
499437
},
500438
{
501439
"group": "Resend",
502-
"pages": [
503-
"integrations/apis/resend",
504-
"integrations/apis/resend-tasks"
505-
]
440+
"pages": ["integrations/apis/resend", "integrations/apis/resend-tasks"]
506441
},
507442
{
508443
"group": "Shopify",
@@ -514,10 +449,7 @@
514449
},
515450
{
516451
"group": "Slack",
517-
"pages": [
518-
"integrations/apis/slack",
519-
"integrations/apis/slack-tasks"
520-
]
452+
"pages": ["integrations/apis/slack", "integrations/apis/slack-tasks"]
521453
},
522454
"integrations/apis/stripe",
523455
{
@@ -543,9 +475,7 @@
543475
"sdk/triggerclient/constructor",
544476
{
545477
"group": "Instance properties",
546-
"pages": [
547-
"sdk/triggerclient/store"
548-
]
478+
"pages": ["sdk/triggerclient/store"]
549479
},
550480
{
551481
"group": "Instance methods",
@@ -608,10 +538,7 @@
608538
"sdk/dynamictrigger/constructor",
609539
{
610540
"group": "Instance methods",
611-
"pages": [
612-
"sdk/dynamictrigger/register",
613-
"sdk/dynamictrigger/unregister"
614-
]
541+
"pages": ["sdk/dynamictrigger/register", "sdk/dynamictrigger/unregister"]
615542
}
616543
]
617544
},
@@ -622,10 +549,7 @@
622549
"sdk/dynamicschedule/constructor",
623550
{
624551
"group": "Instance methods",
625-
"pages": [
626-
"sdk/dynamicschedule/register",
627-
"sdk/dynamicschedule/unregister"
628-
]
552+
"pages": ["sdk/dynamicschedule/register", "sdk/dynamicschedule/unregister"]
629553
}
630554
]
631555
},
@@ -638,9 +562,7 @@
638562
{
639563
"group": "HTTP Reference",
640564
"version": "v2",
641-
"pages": [
642-
"sdk/api-reference/events/create-an-event"
643-
]
565+
"pages": ["sdk/api-reference/events/create-an-event"]
644566
},
645567
{
646568
"group": "React SDK",
@@ -656,14 +578,12 @@
656578
{
657579
"group": "Overview",
658580
"version": "v2",
659-
"pages": [
660-
"examples/introduction"
661-
]
581+
"pages": ["examples/introduction"]
662582
}
663583
],
664584
"footerSocials": {
665585
"twitter": "https://twitter.com/triggerdotdev",
666586
"github": "https://github.com/triggerdotdev",
667587
"linkedin": "https://www.linkedin.com/company/triggerdotdev"
668588
}
669-
}
589+
}

‎docs/v3/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Trigger.dev v3 makes it easy to write reliable long-running tasks without timeou
1515
- We run your tasks with no timeouts. You don't have to manage any infrastructure (unless you [self-host](/v3/open-source-self-hosting)). Workers are automatically scaled and managed for you.
1616
- We provide a multi-tenant queue that is used when triggering tasks.
1717
- We provide an SDK and CLI for writing tasks in your existing codebase, inside [/trigger folders](/v3/trigger-folder).
18-
- We provide different types of tasks: [regular](/v3/tasks-regular), [scheduled](/v3/tasks-scheduled), [zod](/v3/tasks-zod), [webhooks](/v3/tasks-webhooks).
18+
- We provide different types of tasks: [regular](/v3/tasks-regular) and [scheduled](/v3/tasks-scheduled).
1919
- We provide a dashboard for monitoring, debugging, and managing your tasks.
2020

2121
We're [open source](https://github.com/triggerdotdev/trigger.dev) and you can choose to use the [Trigger.dev Cloud](https://cloud.trigger.dev) or [Self-host Trigger.dev](/v3/open-source-self-hosting) on your own infrastructure.

‎docs/v3/tasks-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: "Tasks"
44
description: "Tasks are functions that can run for a long time and provide strong resilience to failure."
55
---
66

7-
There are different types of tasks including [regular tasks](/v3/tasks-regular), [scheduled tasks](/v3/tasks-scheduled), [zod tasks](/v3/tasks-zod) and [webhook tasks](/v3/tasks-webhooks).
7+
There are different types of tasks including [regular tasks](/v3/tasks-regular) and [scheduled tasks](/v3/tasks-scheduled).
88

99
## Hello world task and how to trigger it
1010

0 commit comments

Comments
 (0)