(docs): Link lifecycle page to architecture guide#2467
Merged
Conversation
The lifecycle spec page shows the sequence diagram and JSON-RPC wire format but does not point readers to SDK-level examples. Added an Info callout after the diagram linking to the Architecture guide, which already walks through the initialization sequence with pseudo-code. The guide already links to the spec; this adds the reverse link so readers starting from the spec can find the code-level view. Applied to draft only. Fixes #106 🏠 Remote-Dev: homespace
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
localden
changed the title
localden
added
documentation
Member
There was a problem hiding this comment.
The lifecycle being discussed on this page is:
- Initialization: Capability negotiation and protocol version agreement
- Operation: Normal protocol communication
- Shutdown: Graceful termination of the connection
with most of the focus on Initialization and Shutdown. In comparison, the linked example is:
- Initialization (Lifecycle Management)
- Tool Discovery (Primitives)
- Tool Execution (Primitives)
- Real-time Updates (Notifications)
So, some overlap but a bit different. Also, there is a little bit pseudo-code, but I wouldn't say that "map[s]" to SDK code".
I thinking mapping to SDK code is challenging because: (1) which SDK?, and (2) ideally, the SDK abstracts most lifecycle operations away from the user.
To be honest, I'm not clear on the goal of #106, so it's hard to make recommendation beyond what the documentation already provides (which has significantly changed since December 2024).
dsp-ant
approved these changes
Mar 26, 2026
cliffhall
approved these changes
Mar 26, 2026
Member
|
/lgtm |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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
4 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.
Fixes #106.
Problem
The lifecycle spec page shows the sequence diagram and JSON-RPC wire format but offers no pointer to SDK-level examples. Readers starting from the spec have to find the code mapping on their own.
Changes
Added an
<Info>callout immediately after the lifecycle sequence diagram, linking to the Architecture guide's example section. That section already walks through the initialization handshake with JSON-RPC messages alongside pseudo-code showingsession.initialize()and capability checking.The guide already links to the spec (
/specification/latest/basic/lifecycle); this adds the reverse link.Context
This issue was filed in December 2024, before the docs redesign (#1044) added
architecture.mdx. That redesign largely addressed the underlying complaint by providing the lifecycle-to-code mapping. The remaining gap was discoverability from the spec side, which this closes.Applied to draft only.