James Ritchie
65fa8300ad
* Removed next references in the ReadMe * FAQ improvements to update Next.js references * Added a new Frameworks page with logos to link to the quick start guides * Renamed the mdx file so the link works * Added basic platform guides * Introduction doesn’t reference next.js only * Added a note about serverless and restructured the side menu * Added more frameworks pages to the manual install section * Fixed SVG error * Coming soon guides now using snippets so they can be in 2 places while we work on them * Removed redirects * Added a new named icon * increased fireworks particle count slightly * Creating a route for the onboarding and link to access it anytime from the side menu * Moved the onboarding into new components * Updated the routes for the onboarding page * Onboarding is now Setup and the frameworks overview page now links to different framework page in the onboarding side nav * URLs and pages renamed to ‘setup’ * URLs and pages renamed to ‘setup’ * Fixed some old named component imports * WIP on a new less hacked-in background image * Added svg logos for all the frameworks * New paths for the new framework pages * Side menu collapses once you selected a framework * Temporary Nuxt page * New routes for the new frameworks * New ‘framework coming soon’ component - now used in the coming soon framework pages * Moved/removed files * Moved all svg framework logos into a new folder and file * balanced the logo sizes * Framework coming soon pages take a name and url * New express svg logo * New component for a Framework item in the grid * Added information and design for the coming soon frameworks * Change the grid to 1 row if jobs === 0 * Updated the framework coming soon snippet and added it to the relevant pages * Express now 2nd in all lists * Added link to long running server support discussion * New logo to include next.js + supabase quick start * roadmap now links to homepage with page anchor to roadmap section * changelog now links to Github releases page * Removed reference to Next.js * Docs pages with coming soon info all share the same framework snippets * Fixed issue of missing props * Moved the fireworks effect into a separate file to make it easier for adding more framework onboarding pages * Info callouts have a more muted style * Added a callout to the top of the next onboarding to reference Serverless-only support * Moved the callout explaining scheduled triggers not working in dev to the bottom of the test panel This is to resolve eric’s UX ticket: https://github.com/triggerdotdev/trigger.dev/issues/416 * Added groundwork for Nest.js framework * Using framer motion for the menu transition instead of css - now has a slight spring and is snappier * redirect the manual setup page to the new nextjs setup page * Fixed broken docs link * Added a readme.md to next.js package * Capital I for integration * Renamed component: NextDevCommand to RunDevCommand * Made required props non-optional * CLI now points at manual install guides if no Next project detected * Explicitly made supported default to false (it was working but a bit hard to read) * Added links to all github issues for the frameworks coming soon component --------- Co-authored-by: Matt Aitken <matt@mattaitken.com>
352 lines
9.9 KiB
JSON
352 lines
9.9 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/schema.json",
|
|
"name": "Trigger.dev",
|
|
"logo": {
|
|
"dark": "/logo/dark.png",
|
|
"light": "/logo/light.png",
|
|
"href": "https://trigger.dev"
|
|
},
|
|
"favicon": "/images/favicon.png",
|
|
"colors": {
|
|
"primary": "#818cf8",
|
|
"light": "#818cf8",
|
|
"dark": "#818cf8",
|
|
"anchors": {
|
|
"from": "#fff",
|
|
"to": "#eee"
|
|
}
|
|
},
|
|
"backgroundImage": "/images/docs-background.png",
|
|
"modeToggle": {
|
|
"default": "dark",
|
|
"isHidden": true
|
|
},
|
|
"feedback": {
|
|
"suggestEdit": true,
|
|
"raiseIssue": true,
|
|
"thumbsRating": true
|
|
},
|
|
"topbarCtaButton": {
|
|
"type": "github",
|
|
"url": "https://github.com/triggerdotdev/trigger.dev"
|
|
},
|
|
"topbarLinks": [
|
|
{
|
|
"name": "Community",
|
|
"url": "https://discord.gg/kA47vcd8P6"
|
|
}
|
|
],
|
|
"tabs": [
|
|
{
|
|
"name": "Integrations",
|
|
"url": "integrations"
|
|
},
|
|
{
|
|
"name": "Reference",
|
|
"url": "sdk"
|
|
},
|
|
{
|
|
"name": "Example Jobs",
|
|
"url": "examples"
|
|
}
|
|
],
|
|
"redirects": [
|
|
{
|
|
"source": "/documentation/quickstart",
|
|
"destination": "/documentation/quickstarts/introduction"
|
|
},
|
|
{
|
|
"source": "/documentation/guides/manual",
|
|
"destination": "/documentation/guides/manual/nextjs"
|
|
}
|
|
],
|
|
"navigation": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"documentation/introduction",
|
|
{
|
|
"group": "Quick Starts",
|
|
"pages": [
|
|
"documentation/quickstarts/introduction",
|
|
{
|
|
"group": "Frameworks",
|
|
"pages": [
|
|
"documentation/quickstarts/nextjs",
|
|
"documentation/quickstarts/express",
|
|
"documentation/quickstarts/remix",
|
|
"documentation/quickstarts/redwood",
|
|
"documentation/quickstarts/astro",
|
|
"documentation/quickstarts/nuxt",
|
|
"documentation/quickstarts/sveltekit",
|
|
"documentation/quickstarts/fastify"
|
|
]
|
|
},
|
|
"documentation/quickstarts/supabase"
|
|
]
|
|
},
|
|
"documentation/guides/create-a-job",
|
|
"documentation/guides/video-walkthrough"
|
|
]
|
|
},
|
|
{
|
|
"group": "Concepts",
|
|
"pages": [
|
|
"documentation/concepts/what-is-triggerdotdev",
|
|
"documentation/concepts/limitations",
|
|
"documentation/concepts/projects",
|
|
"documentation/concepts/client-adaptors",
|
|
{
|
|
"group": "Jobs, Runs & Tasks",
|
|
"pages": [
|
|
"documentation/concepts/jobs",
|
|
"documentation/concepts/runs",
|
|
"documentation/concepts/tasks"
|
|
]
|
|
},
|
|
{
|
|
"group": "Triggers",
|
|
"pages": [
|
|
"documentation/concepts/triggers/introduction",
|
|
"documentation/concepts/triggers/webhooks",
|
|
"documentation/concepts/triggers/events",
|
|
"documentation/concepts/triggers/scheduled",
|
|
"documentation/concepts/triggers/dynamic"
|
|
]
|
|
},
|
|
"documentation/concepts/resumability",
|
|
"documentation/concepts/delays",
|
|
"documentation/concepts/integrations",
|
|
"documentation/concepts/connect",
|
|
"documentation/concepts/environments-endpoints"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
{
|
|
"group": "Platforms",
|
|
"pages": [
|
|
"documentation/guides/platforms/nextjs",
|
|
"documentation/guides/platforms/express",
|
|
"documentation/guides/platforms/remix",
|
|
"documentation/guides/platforms/redwood",
|
|
"documentation/guides/platforms/astro",
|
|
"documentation/guides/platforms/nuxt",
|
|
"documentation/guides/platforms/sveltekit",
|
|
"documentation/guides/platforms/fastify"
|
|
]
|
|
},
|
|
"documentation/guides/cli",
|
|
{
|
|
"group": "Manual setup",
|
|
"pages": [
|
|
"documentation/guides/manual/nextjs",
|
|
"documentation/guides/manual/express",
|
|
"documentation/guides/manual/remix",
|
|
"documentation/guides/manual/redwood",
|
|
"documentation/guides/manual/astro",
|
|
"documentation/guides/manual/nuxt",
|
|
"documentation/guides/manual/sveltekit",
|
|
"documentation/guides/manual/fastify"
|
|
]
|
|
},
|
|
|
|
"documentation/guides/running-jobs",
|
|
"documentation/guides/jobs/managing",
|
|
{
|
|
"group": "Using the Dashboard",
|
|
"pages": [
|
|
"documentation/guides/managing-jobs",
|
|
"documentation/guides/viewing-runs",
|
|
"documentation/guides/testing-jobs",
|
|
"documentation/guides/rerunning"
|
|
]
|
|
},
|
|
{
|
|
"group": "Using Integrations",
|
|
"pages": [
|
|
"documentation/guides/using-integrations",
|
|
"documentation/guides/using-integrations-apikeys",
|
|
"documentation/guides/using-integrations-oauth"
|
|
]
|
|
},
|
|
"documentation/guides/react-hooks",
|
|
{
|
|
"group": "Deployment",
|
|
"pages": [
|
|
"documentation/guides/deployment",
|
|
"documentation/guides/deployment-setup",
|
|
"documentation/guides/deployment-manual",
|
|
"documentation/guides/deployment-automatic"
|
|
]
|
|
},
|
|
"documentation/guides/event-filter",
|
|
"documentation/guides/zod",
|
|
{
|
|
"group": "Self hosting",
|
|
"pages": [
|
|
"documentation/guides/self-hosting",
|
|
"documentation/guides/self-hosting/flyio",
|
|
"documentation/guides/self-hosting/render",
|
|
"documentation/guides/self-hosting/supabase",
|
|
"documentation/guides/tunneling-platform"
|
|
]
|
|
},
|
|
"documentation/guides/contributing"
|
|
]
|
|
},
|
|
{
|
|
"group": "Community & Support",
|
|
"pages": [
|
|
"documentation/get-help",
|
|
"documentation/faq",
|
|
"documentation/changelog",
|
|
"documentation/roadmap"
|
|
]
|
|
},
|
|
{
|
|
"group": "Overview",
|
|
"pages": [
|
|
"integrations/introduction",
|
|
{
|
|
"group": "Create an Integration",
|
|
"pages": [
|
|
"integrations/create",
|
|
"integrations/create-setup",
|
|
"integrations/create-anatomy",
|
|
"integrations/create-oauth",
|
|
"integrations/create-client",
|
|
"integrations/create-tasks",
|
|
"integrations/create-triggers",
|
|
"integrations/create-testing",
|
|
"integrations/create-publishing"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
"integrations/apis/airtable",
|
|
{
|
|
"group": "GitHub",
|
|
"pages": [
|
|
"integrations/apis/github",
|
|
"integrations/apis/github-triggers",
|
|
"integrations/apis/github-tasks"
|
|
]
|
|
},
|
|
"integrations/apis/openai",
|
|
"integrations/apis/plain",
|
|
"integrations/apis/resend",
|
|
"integrations/apis/sendgrid",
|
|
"integrations/apis/slack",
|
|
"integrations/apis/stripe",
|
|
{
|
|
"group": "Supabase",
|
|
"pages": [
|
|
"integrations/apis/supabase/introduction",
|
|
"integrations/apis/supabase/management",
|
|
"integrations/apis/supabase/client"
|
|
]
|
|
},
|
|
"integrations/apis/typeform"
|
|
]
|
|
},
|
|
{
|
|
"group": "SDK",
|
|
"pages": [
|
|
"sdk/introduction",
|
|
{
|
|
"group": "TriggerClient",
|
|
"pages": [
|
|
"sdk/triggerclient/overview",
|
|
"sdk/triggerclient/constructor",
|
|
{
|
|
"group": "Instance methods",
|
|
"pages": [
|
|
"sdk/triggerclient/instancemethods/sendevent",
|
|
"sdk/triggerclient/instancemethods/getevent",
|
|
"sdk/triggerclient/instancemethods/getruns",
|
|
"sdk/triggerclient/instancemethods/getrun"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sdk/job",
|
|
{
|
|
"group": "IO",
|
|
"pages": [
|
|
"sdk/io/overview",
|
|
"sdk/io/logger",
|
|
"sdk/io/wait",
|
|
"sdk/io/sendevent",
|
|
"sdk/io/runtask",
|
|
"sdk/io/try",
|
|
"sdk/io/backgroundfetch",
|
|
"sdk/io/registerinterval",
|
|
"sdk/io/unregisterinterval",
|
|
"sdk/io/registercron",
|
|
"sdk/io/unregistercron",
|
|
"sdk/io/registertrigger"
|
|
]
|
|
},
|
|
"sdk/context",
|
|
"sdk/eventtrigger",
|
|
"sdk/crontrigger",
|
|
"sdk/intervaltrigger",
|
|
{
|
|
"group": "DynamicTrigger",
|
|
"pages": [
|
|
"sdk/dynamictrigger/overview",
|
|
"sdk/dynamictrigger/constructor",
|
|
{
|
|
"group": "Instance methods",
|
|
"pages": ["sdk/dynamictrigger/register", "sdk/dynamictrigger/unregister"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "DynamicSchedule",
|
|
"pages": [
|
|
"sdk/dynamicschedule/overview",
|
|
"sdk/dynamicschedule/constructor",
|
|
{
|
|
"group": "Instance methods",
|
|
"pages": ["sdk/dynamicschedule/register", "sdk/dynamicschedule/unregister"]
|
|
}
|
|
]
|
|
},
|
|
"sdk/connection-auth",
|
|
"sdk/istriggererror",
|
|
"sdk/redactstring"
|
|
]
|
|
},
|
|
{
|
|
"group": "React SDK",
|
|
"pages": [
|
|
"sdk/react/introduction",
|
|
"sdk/react/triggerprovider",
|
|
"sdk/react/useeventdetails",
|
|
"sdk/react/useeventrundetails",
|
|
"sdk/react/userundetails"
|
|
]
|
|
},
|
|
{
|
|
"group": "Overview",
|
|
"pages": ["examples/introduction"]
|
|
}
|
|
],
|
|
"footerSocials": {
|
|
"twitter": "https://twitter.com/triggerdotdev",
|
|
"github": "https://github.com/triggerdotdev",
|
|
"linkedin": "https://www.linkedin.com/company/triggerdotdev"
|
|
},
|
|
"analytics": {
|
|
"posthog": {
|
|
"apiKey": "phc_hwYmedO564b3Ik8nhA4Csrb5SueY0EwFJWCbseGwWW"
|
|
}
|
|
}
|
|
}
|