Eric Allam
3252d9ec31
* WIP realtime/frontend docs * WIP * Deleted old examples * Improved styling * Improved the generated example styles * More style improvements * More realtime docs * Couple doc tweeks * runs-and-attempts -> runs * Remove the prerelease package version --------- Co-authored-by: James Ritchie <james@trigger.dev>
400 lines
9.1 KiB
JSON
400 lines
9.1 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/schema.json",
|
|
"name": "Trigger.dev",
|
|
"openapi": [
|
|
"/openapi.yml",
|
|
"/v3-openapi.yaml"
|
|
],
|
|
"api": {
|
|
"playground": {
|
|
"mode": "simple"
|
|
},
|
|
"maintainOrder": true
|
|
},
|
|
"logo": {
|
|
"dark": "/logo/dark.png",
|
|
"light": "/logo/light.png",
|
|
"href": "https://trigger.dev"
|
|
},
|
|
"favicon": "/images/favicon.png",
|
|
"colors": {
|
|
"primary": "#A8FF53",
|
|
"light": "#A8FF53",
|
|
"dark": "#A8FF53",
|
|
"anchors": {
|
|
"from": "#252630",
|
|
"to": "#252630"
|
|
},
|
|
"background": {
|
|
"light": "#fff",
|
|
"dark": "#121317"
|
|
}
|
|
},
|
|
"theme": "quill",
|
|
"modeToggle": {
|
|
"default": "dark",
|
|
"isHidden": true
|
|
},
|
|
"feedback": {
|
|
"suggestEdit": true,
|
|
"raiseIssue": true,
|
|
"thumbsRating": true
|
|
},
|
|
"topbarCtaButton": {
|
|
"type": "github",
|
|
"url": "https://github.com/triggerdotdev/trigger.dev"
|
|
},
|
|
"topbarLinks": [
|
|
{
|
|
"name": "Switch to v2 docs",
|
|
"url": "https://v2docs.trigger.dev/documentation/introduction"
|
|
},
|
|
{
|
|
"name": "Discord",
|
|
"url": "https://trigger.dev/discord"
|
|
}
|
|
],
|
|
"redirects": [
|
|
{
|
|
"source": "/v3/feature-matrix",
|
|
"destination": "https://feedback.trigger.dev/roadmap"
|
|
},
|
|
{
|
|
"source": "/v3/upgrading-from-v2",
|
|
"destination": "/guides/use-cases/upgrading-from-v2"
|
|
},
|
|
{
|
|
"source": "/v3/open-source-self-hosting",
|
|
"destination": "/open-source-self-hosting"
|
|
},
|
|
{
|
|
"source": "/v3/:slug*",
|
|
"destination": "/:slug*"
|
|
},
|
|
{
|
|
"source": "/reattempting-replaying",
|
|
"destination": "/replaying"
|
|
},
|
|
{
|
|
"source": "/tasks-overview",
|
|
"destination": "/tasks/overview"
|
|
},
|
|
{
|
|
"source": "/tasks-scheduled",
|
|
"destination": "/tasks/scheduled"
|
|
},
|
|
{
|
|
"source": "/trigger-folder",
|
|
"destination": "/config/config-file"
|
|
},
|
|
{
|
|
"source": "/trigger-config",
|
|
"destination": "/config/config-file"
|
|
},
|
|
{
|
|
"source": "/guides/frameworks/introduction",
|
|
"destination": "/guides/introduction"
|
|
},
|
|
{
|
|
"source": "/guides/examples/intro",
|
|
"destination": "/guides/introduction"
|
|
},
|
|
{
|
|
"source": "/examples/:slug*",
|
|
"destination": "/guides/examples/:slug*"
|
|
},
|
|
{
|
|
"source": "/realtime",
|
|
"destination": "/realtime/overview"
|
|
},
|
|
{
|
|
"source": "/runs-and-attempts",
|
|
"destination": "/runs"
|
|
}
|
|
],
|
|
"anchors": [
|
|
{
|
|
"name": "Guides & examples",
|
|
"icon": "book",
|
|
"url": "guides"
|
|
}
|
|
],
|
|
"navigation": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"introduction",
|
|
"quick-start",
|
|
"how-it-works",
|
|
"upgrading-beta",
|
|
"limits"
|
|
]
|
|
},
|
|
{
|
|
"group": "Fundamentals",
|
|
"pages": [
|
|
{
|
|
"group": "Tasks",
|
|
"pages": [
|
|
"tasks/overview",
|
|
"tasks/schemaTask",
|
|
"tasks/scheduled"
|
|
]
|
|
},
|
|
"triggering",
|
|
"runs",
|
|
"apikeys",
|
|
{
|
|
"group": "Configuration",
|
|
"pages": [
|
|
"config/config-file",
|
|
"config/extensions/overview"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Development",
|
|
"pages": [
|
|
"cli-dev",
|
|
"run-tests"
|
|
]
|
|
},
|
|
{
|
|
"group": "Deployment",
|
|
"pages": [
|
|
"deploy-environment-variables",
|
|
"cli-deploy",
|
|
"github-actions",
|
|
{
|
|
"group": "Deployment integrations",
|
|
"pages": [
|
|
"vercel-integration"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Writing tasks",
|
|
"pages": [
|
|
"writing-tasks-introduction",
|
|
"logging",
|
|
"errors-retrying",
|
|
{
|
|
"group": "Wait",
|
|
"pages": [
|
|
"wait",
|
|
"wait-for",
|
|
"wait-until",
|
|
"wait-for-event",
|
|
"wait-for-request"
|
|
]
|
|
},
|
|
"queue-concurrency",
|
|
"versioning",
|
|
"machines",
|
|
"idempotency",
|
|
"replaying",
|
|
"runs/max-duration",
|
|
"tags",
|
|
"runs/metadata",
|
|
"run-usage",
|
|
"context"
|
|
]
|
|
},
|
|
{
|
|
"group": "Frontend usage",
|
|
"pages": [
|
|
"frontend/overview",
|
|
"frontend/react-hooks"
|
|
]
|
|
},
|
|
{
|
|
"group": "Realtime API",
|
|
"pages": [
|
|
"realtime/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "API reference",
|
|
"pages": [
|
|
"management/overview",
|
|
{
|
|
"group": "Tasks API",
|
|
"pages": [
|
|
"management/tasks/trigger",
|
|
"management/tasks/batch-trigger"
|
|
]
|
|
},
|
|
{
|
|
"group": "Runs API",
|
|
"pages": [
|
|
"management/runs/list",
|
|
"management/runs/retrieve",
|
|
"management/runs/replay",
|
|
"management/runs/cancel",
|
|
"management/runs/reschedule",
|
|
"management/runs/update-metadata"
|
|
]
|
|
},
|
|
{
|
|
"group": "Schedules API",
|
|
"pages": [
|
|
"management/schedules/list",
|
|
"management/schedules/create",
|
|
"management/schedules/retrieve",
|
|
"management/schedules/update",
|
|
"management/schedules/delete",
|
|
"management/schedules/deactivate",
|
|
"management/schedules/activate",
|
|
"management/schedules/timezones"
|
|
]
|
|
},
|
|
{
|
|
"group": "Env Vars API",
|
|
"pages": [
|
|
"management/envvars/list",
|
|
"management/envvars/import",
|
|
"management/envvars/create",
|
|
"management/envvars/retrieve",
|
|
"management/envvars/update",
|
|
"management/envvars/delete"
|
|
]
|
|
},
|
|
{
|
|
"group": "Projects API",
|
|
"pages": [
|
|
"management/projects/runs"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "CLI",
|
|
"pages": [
|
|
"cli-introduction",
|
|
{
|
|
"group": "Commands",
|
|
"pages": [
|
|
"cli-login-commands",
|
|
"cli-init-commands",
|
|
"cli-dev-commands",
|
|
"cli-deploy-commands",
|
|
"cli-whoami-commands",
|
|
"cli-logout-commands",
|
|
"cli-list-profiles-commands",
|
|
"cli-update-commands"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Open source",
|
|
"pages": [
|
|
"open-source-self-hosting",
|
|
"open-source-contributing",
|
|
"github-repo",
|
|
"changelog",
|
|
"roadmap"
|
|
]
|
|
},
|
|
{
|
|
"group": "Troubleshooting",
|
|
"pages": [
|
|
"troubleshooting",
|
|
"upgrading-packages",
|
|
"troubleshooting-alerts",
|
|
"troubleshooting-uptime-status",
|
|
"troubleshooting-github-issues",
|
|
"request-feature"
|
|
]
|
|
},
|
|
{
|
|
"group": "Help",
|
|
"pages": [
|
|
"community",
|
|
"help-slack",
|
|
"help-email"
|
|
]
|
|
},
|
|
{
|
|
"group": "",
|
|
"pages": [
|
|
"guides/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Frameworks",
|
|
"pages": [
|
|
"guides/frameworks/bun",
|
|
"guides/frameworks/nextjs",
|
|
"guides/frameworks/nodejs",
|
|
"guides/frameworks/remix"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
"guides/frameworks/prisma",
|
|
"guides/frameworks/sequin",
|
|
{
|
|
"group": "Supabase",
|
|
"icon": "bolt",
|
|
"iconType": "solid",
|
|
"pages": [
|
|
"guides/frameworks/supabase-guides-overview",
|
|
"guides/frameworks/supabase-edge-functions-basic",
|
|
"guides/frameworks/supabase-edge-functions-database-webhooks"
|
|
]
|
|
},
|
|
{
|
|
"group": "Webhooks",
|
|
"icon": "webhook",
|
|
"iconType": "solid",
|
|
"pages": [
|
|
"guides/frameworks/webhooks-guides-overview",
|
|
"guides/frameworks/nextjs-webhooks",
|
|
"guides/frameworks/remix-webhooks",
|
|
"guides/examples/stripe-webhook"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Example tasks",
|
|
"pages": [
|
|
"guides/examples/dall-e3-generate-image",
|
|
"guides/examples/deepgram-transcribe-audio",
|
|
"guides/examples/ffmpeg-video-processing",
|
|
"guides/examples/open-ai-with-retrying",
|
|
"guides/examples/pdf-to-image",
|
|
"guides/examples/puppeteer",
|
|
"guides/examples/scrape-hacker-news",
|
|
"guides/examples/sentry-error-tracking",
|
|
"guides/examples/sharp-image-processing",
|
|
"guides/examples/supabase-database-operations",
|
|
"guides/examples/supabase-storage-upload",
|
|
"guides/examples/react-pdf",
|
|
"guides/examples/resend-email-sequence",
|
|
"guides/examples/vercel-ai-sdk"
|
|
]
|
|
},
|
|
{
|
|
"group": "Dashboard",
|
|
"pages": [
|
|
"guides/dashboard/creating-a-project"
|
|
]
|
|
},
|
|
{
|
|
"group": "Migrations",
|
|
"pages": [
|
|
"guides/use-cases/upgrading-from-v2"
|
|
]
|
|
}
|
|
],
|
|
"footerSocials": {
|
|
"twitter": "https://twitter.com/triggerdotdev",
|
|
"github": "https://github.com/triggerdotdev",
|
|
"linkedin": "https://www.linkedin.com/company/triggerdotdev"
|
|
}
|
|
} |