This page documents the structure and organization of the Trigger.dev documentation system, including the docs.json configuration file, navigation hierarchy, and Mintlify platform integration. For information about the example projects and code snippets provided in the documentation, see Example Projects and Tasks. For details on documented integration patterns, see Integration Patterns.
The Trigger.dev documentation is built and deployed using Mintlify, a documentation platform that provides:
docs.jsonThe platform enables the documentation to be version-controlled alongside the codebase in the /docs directory, allowing developers to update documentation in the same pull requests as code changes.
Sources: docs/docs.json1-701
The entire documentation site is configured through a single JSON file at docs/docs.json This file defines all aspects of the documentation site structure, appearance, and behavior.
Sources: docs/docs.json1-701
The documentation uses the "maple" theme with a custom color scheme:
| Property | Value | Purpose |
|---|---|---|
theme | "maple" | Mintlify theme identifier |
colors.primary | "#A8FF53" | Primary brand color (lime green) |
colors.light | "#A8FF53" | Light mode accent color |
colors.dark | "#A8FF53" | Dark mode accent color |
appearance.default | "dark" | Default color mode |
appearance.strict | true | Disable theme switching |
Sources: docs/docs.json3-487
The contextual.options array enables interactive features for documentation readers:
copy: Enables copying code snippets from the documentationview: Allows viewing code files in their original contextclaude: Integrates with Claude AI for documentation assistanceSources: docs/docs.json12-18
The documentation is organized into three primary dropdowns, each serving a distinct purpose. The navigation structure is defined in the navigation.dropdowns array.
Sources: docs/docs.json19-463
The main Documentation dropdown contains 14 groups covering core platform concepts, configuration, and deployment:
| Group | Purpose | Example Pages |
|---|---|---|
| Getting started | Initial setup and onboarding | introduction, quick-start, manual-setup, video-walkthrough |
| Fundamentals | Core concepts | tasks/overview, triggering, runs, apikeys |
| Writing tasks | Task development patterns | logging, errors-retrying, wait, queue-concurrency |
| Configuration | Build and deployment settings | config/config-file, config/extensions/* |
| Development | Local development workflows | cli-dev |
| Deployment | Production deployment | deployment/overview, github-actions, deployment/atomic-deployment |
| Realtime | Real-time subscriptions | realtime/overview, realtime/react-hooks/*, realtime/backend/* |
| CLI | Command-line interface | cli-deploy-commands, cli-dev-commands, cli-login-commands |
| MCP Server | Model Context Protocol | mcp-introduction, mcp-tools, mcp-agent-rules |
| Using the Dashboard | Web UI features | run-tests, troubleshooting-alerts, replaying, bulk-actions |
| Troubleshooting | Problem resolution | troubleshooting, troubleshooting-debugging-in-vscode |
| Self-hosting | On-premises deployment | self-hosting/overview, self-hosting/docker, self-hosting/kubernetes |
| Open source | Community and contribution | open-source-contributing, github-repo, changelog |
| Help | Support channels | community, help-slack, help-email |
Sources: docs/docs.json25-249
The API reference dropdown provides REST API documentation generated from OpenAPI specifications:
| Group | Endpoints | Purpose |
|---|---|---|
| API reference | Overview pages | management/overview, management/authentication, management/errors-and-retries |
| Tasks API | Task operations | management/tasks/trigger, management/tasks/batch-trigger |
| Runs API | Run operations | management/runs/list, management/runs/retrieve, management/runs/replay, management/runs/cancel |
| Schedules API | Schedule CRUD | management/schedules/create, management/schedules/update, management/schedules/delete |
| Env Vars API | Environment variables | management/envvars/list, management/envvars/create, management/envvars/update |
The API documentation is generated from two OpenAPI specification files referenced in the api.openapi array:
Sources: docs/docs.json251-478
The Guides & examples dropdown contains practical code examples and integration tutorials organized into 9 groups:
| Group | Count | Examples |
|---|---|---|
| Frameworks | 5 | guides/frameworks/bun, guides/frameworks/nextjs, guides/frameworks/remix |
| Guides | ~15 | guides/ai-agents/*, guides/frameworks/prisma, guides/frameworks/supabase-* |
| Use cases | 4 | guides/use-cases/data-processing-etl, guides/use-cases/media-processing |
| Example projects | 13 | guides/example-projects/batch-llm-evaluator, guides/example-projects/realtime-csv-importer |
| Python guides | 4 | guides/python/python-image-processing, guides/python/python-crawl4ai |
| Example tasks | 25+ | guides/examples/puppeteer, guides/examples/ffmpeg-video-processing |
| Migration guides | 1 | migration-mergent |
| Community packages | 4 | guides/community/dotenvx, guides/community/sveltekit |
Sources: docs/docs.json310-461
Documentation pages follow consistent organizational patterns based on their type.
Many sections use nested groups to organize related content hierarchically. For example, the Tasks section nests multiple pages under a single group entry:
The Build extensions section demonstrates deeper nesting with sub-groups:
Sources: docs/docs.json42-111
Example project pages typically include:
This pattern is evident in files like docs/guides/example-projects/realtime-fal-ai.mdx1-44 and docs/guides/example-projects/openai-agent-sdk-guardrails.mdx1-61
Sources: docs/guides/example-projects/realtime-fal-ai.mdx1-44 docs/guides/example-projects/openai-agent-sdk-guardrails.mdx1-61
Example task pages follow a simpler pattern:
trigger.config.tsExample: docs/guides/examples/scrape-hacker-news.mdx1-253 and docs/guides/examples/fal-ai-image-to-cartoon.mdx1-112
Sources: docs/guides/examples/scrape-hacker-news.mdx1-253 docs/guides/examples/fal-ai-image-to-cartoon.mdx1-112
Use case pages follow this structure:
The workflow diagrams use consistent node naming patterns:
processVideo, downloadFromStorage){Approved?}, {Source Resolution?})batchTriggerAndWait)Example: docs/guides/use-cases/media-processing.mdx1-192
Sources: docs/guides/use-cases/media-processing.mdx1-192 docs/guides/use-cases/media-generation.mdx1-145 docs/guides/use-cases/marketing.mdx1-148
Documentation pages reference each other using several conventions.
Reusable content is extracted into snippet files and imported:
These snippets are then rendered inline:
Sources: docs/guides/examples/scrape-hacker-news.mdx7-248 docs/guides/use-cases/overview.mdx7-11
Pages reference other documentation pages using relative paths:
External links to the main website use absolute URLs:
Sources: docs/introduction.mdx9-88 docs/guides/introduction.mdx24-96
Example projects consistently link to their GitHub repository locations:
Individual files within repositories are linked using inline markdown:
Sources: docs/guides/example-projects/realtime-fal-ai.mdx18-27 docs/guides/example-projects/openai-agent-sdk-guardrails.mdx40-50
The documentation includes an extensive redirects system to maintain URL stability as the documentation evolves. Redirects are defined in the redirects array with source/destination pairs.
Sources: docs/docs.json583-700
All v3 documentation URLs redirect to current paths:
Specific v3 pages with special handling:
| Source | Destination | Reason |
|---|---|---|
/v3/feature-matrix | https://feedback.trigger.dev/roadmap | Moved to external roadmap |
/v3/upgrading-from-v2 | /guides/use-cases/upgrading-from-v2 | Moved to guides section |
/v3/open-source-self-hosting | /open-source-self-hosting | Removed version prefix |
Sources: docs/docs.json585-599
The frontend features were reorganized under the realtime namespace:
| Old Path | New Path |
|---|---|
/frontend/overview | /realtime/auth |
/frontend/react-hooks | /realtime/react-hooks/overview |
/frontend/react-hooks/triggering | /realtime/react-hooks/triggering |
/realtime/subscribe-to-run | /realtime/backend/subscribe |
Sources: docs/docs.json641-683
Individual pages that were renamed maintain redirects:
Sources: docs/docs.json605-639
The footer provides social links and categorized navigation links:
Three social media platforms are configured:
https://twitter.com/triggerdotdevhttps://github.com/triggerdotdevhttps://www.linkedin.com/company/triggerdotdevThe footer organizes links into three columns:
| Category | Links |
|---|---|
| Developers | Changelog, Contributing, Open source, GitHub, OSS Friends |
| Product | Pricing, How it works, Features, Roadmap, FAQs, Uptime status |
| Company | Blog, Contact, Careers, Privacy, Terms of service |
Sources: docs/docs.json495-581
To add new documentation pages:
.mdx file in the appropriate directory under /docsdocs.jsonmy-new-page.mdx)Sources: docs/docs.json1-701 docs/guides/examples/scrape-hacker-news.mdx1-6 docs/guides/example-projects/realtime-fal-ai.mdx1-6
The documentation uses separate logo files for light and dark modes:
The logo links back to the main Trigger.dev website. The favicon is configured separately:
Sources: docs/docs.json11-469
The primary navbar action is a GitHub link:
This displays a GitHub icon in the navbar that links to the repository, encouraging community engagement and contributions.
Sources: docs/docs.json489-494
Refresh this wiki
This wiki was recently refreshed. Please wait 7 days to refresh again.