docs(v3): implement durable execution and checkpointing lifecycle guide#3551
docs(v3): implement durable execution and checkpointing lifecycle guide#3551redouanegrib wants to merge 1 commit into
Conversation
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis PR adds a new documentation file explaining Trigger.dev v3's Durable Execution lifecycle. The document covers how the Suspension Loop manages execution state through four transitions (EXECUTING → SUSPENDED → WAITING_TO_RESUME → DEQUEUED), describes the WaitpointType categories (RUN, BATCH, DATETIME, MANUAL) that control resumption behavior, and details CheckpointType options (DOCKER, KUBERNETES, COMPUTE) that enable cost savings by serializing state during idle periods and restoring execution to continue from the same point. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Hi @redouanegrib, thanks for your interest in contributing! This project requires that pull request authors are vouched, and you are not in the list of vouched users. This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
There was a problem hiding this comment.
🚩 New v3/documentation/ directory appears to be outside the established docs site
The project's documentation site lives in the docs/ directory (a Mintlify site configured via docs/docs.json). This new file is placed under v3/documentation/concepts/, which is a new directory not referenced by docs.json or any existing navigation. It's unclear if this is intentional (e.g., an internal design document or RFC) or if the file was meant to be placed under docs/ for inclusion in the public docs site. If the latter, it would need to be moved and registered in the navigation config.
Was this helpful? React with 👍 or 👎 to provide feedback.
| class SuspensionLoop highlight | ||
|
|
There was a problem hiding this comment.
🔴 Mermaid code block is never closed, swallowing all explanatory text
The mermaid code fence is opened at line 9 with ```mermaid but is never closed with a matching ```. As a result, all explanatory documentation text from line 43 ("The Suspension Loop Explained") through the end of the file (line 106) is treated as part of the mermaid code block. This causes the mermaid diagram to fail to render (the prose is invalid mermaid syntax) and makes the entire written documentation invisible to readers — roughly 60% of the file's content is silently lost.
| class SuspensionLoop highlight | |
| class SuspensionLoop highlight |
<!-- devin-review-badge-begin -->
<a href="https://app.devin.ai/review/triggerdotdev/trigger.dev/pull/3551" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1">
<img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review">
</picture>
</a>
<!-- devin-review-badge-end -->
---
*Was this helpful? React with 👍 or 👎 to provide feedback.*
| @@ -0,0 +1,106 @@ | |||
| # Durable Execution Lifecycle in Trigger.dev v3 | |||
There was a problem hiding this comment.
🚩 Missing MDX frontmatter unlike other docs pages
Per docs/CLAUDE.md:12-20, MDX pages in the docs site should include frontmatter with title and description fields. This file has no frontmatter at all. However, this file lives under v3/documentation/ rather than docs/, so it's unclear whether the same Mintlify conventions apply. If this file is intended for the main docs site, the frontmatter will be needed for SEO and sidebar rendering. If it's a standalone reference document outside Mintlify, it may not matter.
Was this helpful? React with 👍 or 👎 to provide feedback.
|
Hi team, I understand the security policy regarding new contributors. I've put significant effort into reverse-engineering the v3 core logic to provide this Durable Execution architectural mapping. As you can see, the CodeRabbit audit is already positive and confirms the technical accuracy of the guide. Could a maintainer please vouch for me or re-open this PR? I believe this documentation will significantly reduce support inquiries regarding task suspension and checkpoints. Best regards. |
1 participant
This PR introduces a high-level architectural guide for the Trigger.dev v3 Durable Execution model.
Key technical contributions:
This guide addresses a critical documentation gap for enterprise users requiring deep understanding of state serialization and compute cost optimization in v3.