Fix documentation issues: deprecated session references, multi-turn guidance, ADK clarifications#1174
Closed
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Closed
Conversation
…multi-turn guidance, ADK clarifications - Replace @session with @trace in v2 documentation (decorators.mdx, spans.mdx) - Add comprehensive multi-turn conversation guidance to traces.mdx - Add ADK integration clarification to prevent duplicate trace confusion in google_adk.mdx - Improve transition from basic to advanced usage in quickstart.mdx - Add deprecation notice to v1 @session decorator documentation Addresses GitHub issues #1169, #1170, #1171, #1172, #1173 Co-Authored-By: Alex <meta.alex.r@gmail.com>
- Add warning that sessions are deprecated in favor of traces - Update title to indicate deprecation - Direct users to v2 traces documentation Co-Authored-By: Alex <meta.alex.r@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Author
|
Closing due to inactivity for more than 7 days. Configure here. |
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.
Fix documentation issues: deprecated session references, multi-turn guidance, ADK clarifications
Summary
This PR addresses multiple documentation issues identified from user feedback, focusing on deprecated terminology, missing guidance, and integration clarifications. The changes include:
GitHub Issues Created: #1169, #1170, #1171, #1172, #1173 (all assigned to Dwij)
Review & Testing Checklist for Human
traces.mdxcontain substantial untested code that should be verified to work correctlyquickstart.mdxare functional and execute without errorsRecommended test plan: Run the multi-turn conversation examples and progressive complexity code snippets in a test environment to verify they execute correctly and produce expected AgentOps trace data.
Diagram
%%{ init : { "theme" : "default" }}%% graph TD A["docs/v2/concepts/decorators.mdx"]:::major-edit B["docs/v2/concepts/spans.mdx"]:::minor-edit C["docs/v2/concepts/traces.mdx"]:::major-edit D["docs/v2/examples/google_adk.mdx"]:::major-edit E["docs/v2/quickstart.mdx"]:::major-edit F["docs/v1/concepts/decorators.mdx"]:::minor-edit G["docs/v1/concepts/sessions.mdx"]:::minor-edit H["User Feedback"]:::context I["AgentOps SDK"]:::context J["@session decorator"]:::context K["@trace decorator"]:::context H -->|reported issues| A H -->|reported issues| C H -->|reported issues| D H -->|reported issues| E A -->|updated references| J A -->|updated references| K C -->|added multi-turn examples| I D -->|added ADK guidance| I E -->|added progressive examples| I subgraph Legend L1["Major Edit"]:::major-edit L2["Minor Edit"]:::minor-edit L3["Context/No Edit"]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes