docs(unstable-v2): list all SessionUpdate variants on the prompt lifecycle page - #1891
Open
tarikermis wants to merge 1 commit into
Open
Conversation
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
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.
Refs #1694 and complements #1858, which fixed the v1 page.
What changed
The v2 prompt-lifecycle pages show JSON examples for the common
session/updatevariants, but they never say the walkthrough is incomplete. The schemas currently define 16 named variants plusotherin stable v2, and 17 plusotherin the unstable schema.This updates both pages to match their schemas:
docs/protocol/v2/prompt-lifecycle.mdx: all 16 stable variants.docs/protocol/v2/draft/prompt-lifecycle.mdx: all 17 unstable variants, includingplan_removedand the unstableusagefield on idle state updates.Each page now has a note explaining that the walkthrough covers common prompt-turn updates, a complete variant table with key fields and links to the relevant topic pages, and a short explanation of custom
_-prefixed variants and the preserve-and-ignore rule.Verification
I did not run
mint dev; the table and<Note>syntax already exist on these pages and were checked statically.Best Regards, Tarik