Docs: How Inngest works - Durable Execution #760
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sylwiavargas
reviewed
May 7, 2024
sylwiavargas
reviewed
May 7, 2024
sylwiavargas
reviewed
May 7, 2024
sylwiavargas
reviewed
May 7, 2024
sylwiavargas
reviewed
May 7, 2024
sylwiavargas
reviewed
May 7, 2024
Co-authored-by: Sylwia Vargas <45401242+sylwiavargas@users.noreply.github.com>
Comment on lines
39
to
41
| Inngest functions are defined with a series of steps that define the execution flow of the function. Each step is defined with a unique ID and a function that defines the work to be done. The data returned can be used by subsequent steps. | ||
|
|
||
| Inngest functions are executed incrementally, _step by step_. As functions are executed, the results of each step are returned to Inngest and persisted in a managed function state store. The function is then re-executed and any steps that have already been successfully executed are [_memoized_](https://en.wikipedia.org/wiki/Memoization). This means that the successfully executed steps are skipped and the SDK injects the data returned by the previous execution into the function. |
There was a problem hiding this comment.
not a blocker but these two paragraphs could really use a flowchart (I will create a Linear ticket as a note to self)
There was a problem hiding this comment.
Yeah - visuals would be great for this page, animations too, but we'll at least start with text 😅
|
|
||
| Inngest functions are executed incrementally, _step by step_. As functions are executed, the results of each step are returned to Inngest and persisted in a managed function state store. The function is then re-executed and any steps that have already been successfully executed are [_memoized_](https://en.wikipedia.org/wiki/Memoization). This means that the successfully executed steps are skipped and the SDK injects the data returned by the previous execution into the function. | ||
|
|
||
| Let's look at an example of a function and walk through how it is executed: |
There was a problem hiding this comment.
not a blocker but a note to self: this section could use a tool like CodeHike to explain this code as a process
sylwiavargas
approved these changes
May 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A new doc page to learn how Inngest works, and how it works with durable execution.
Specifically, this section also should help as the single linkable definition for blog posts and our website content. This also is ideal to have a clear section for search optimization purposes.