Merged
Conversation
Adds a practical how-to page for step metadata following Diataxis. Covers attaching metadata to steps, custom kinds, batching, explicit scoping, cross-run updates, external updates, and dashboard viewing. Explanation content folded inline as context rather than standalone. DEV-276
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
djfarrelly
requested changes
Apr 1, 2026
Member
djfarrelly
left a comment
djfarrelly
left a comment
There was a problem hiding this comment.
Hey @Benanna2019 - I like a lot of parts about this and I actually think this could be the default guide in the main "Learn" side of the docs and the other guide should be in the "Reference" tab.
With that in mind, I'd love for the intro to kind of frame the problem a little bit more. I think with just a little bit of "what this is for" / "what problem am do I need solved" - this guide would hit home really hard for folks. There's lots to like here, but I think we could get it to "click" for readers a lot faster then the examples in this flow get them there really fast which is great for a how-to.
- Rename from "Step metadata" to "Metadata" per team consensus - Add intro explaining why you'd use metadata (debugging, business context, annotating traces) - Reframe "Attach metadata to a step" as "Add metadata to a run" since step.metadata attaches to the run, tracked in its own step - Clarify both approaches: step.metadata for standalone updates, inngest.metadata for updates within an existing step DEV-276
Lead with metadata as a step method alongside step.run, step.sleep, step.waitForEvent. Rework intro and first section so the mental model is clear: step.metadata creates a step that attaches metadata to the run, the memoization ID works like any other step ID. DEV-276
djfarrelly
approved these changes
Apr 7, 2026
AndyInternet
approved these changes
Apr 9, 2026
This was referenced Apr 14, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Adds a practical how-to page for step metadata following the Diataxis framework. Each section is a discrete task with code and just enough context inline:
step.metadataandinngest.metadatainsidestep.run)Explanation content (batched vs API path, durability) is folded inline as context rather than a standalone section.
Companion to the reference page PR. Relates to DEV-276.
Requested reviewers
@AndyInternet @djfarrelly