Skip to content

Fix documentation issues: deprecated session references, multi-turn guidance, ADK clarifications#1174

Closed
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1722142246-fix-documentation-issues
Closed

Fix documentation issues: deprecated session references, multi-turn guidance, ADK clarifications#1174
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1722142246-fix-documentation-issues

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

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:

  • Updated deprecated @session references to @trace throughout v2 documentation
  • Added comprehensive multi-turn conversation guidance with code examples for grouping multiple requests/responses in single traces
  • Added ADK integration clarification to prevent duplicate trace confusion with troubleshooting guidance
  • Improved transition documentation from basic 2-line setup to advanced customization with progressive complexity levels
  • Added deprecation notices to v1 documentation referencing @session and sessions

GitHub Issues Created: #1169, #1170, #1171, #1172, #1173 (all assigned to Dwij)

Review & Testing Checklist for Human

  • Test multi-turn conversation code examples - The new examples in traces.mdx contain substantial untested code that should be verified to work correctly
  • Verify ADK duplicate trace advice - Confirm the troubleshooting guidance for ADK + LiteLLM integration matches actual behavior
  • Test progressive complexity examples - Ensure the 4-level progression examples in quickstart.mdx are functional and execute without errors
  • Validate @session to @trace migration completeness - Check that the migration doesn't miss any behavioral differences that could break user workflows

Recommended 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:#FFFFFF
Loading

Notes

devin-ai-integration Bot and others added 2 commits July 28, 2025 04:57
…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>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

Closing due to inactivity for more than 7 days. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants