Skip to content

Improve documentation on async/await patterns #240

@cwing-nvidia

Description

@cwing-nvidia

Description

Contributors implementing custom resource servers or agents may encounter async/await errors without clear guidance on best practices. This creates unnecessary friction for those less familiar with async Python patterns.

Context
This feedback came from external contributor experience during environment integration work. #203

Proposed improvements

  • Add async/await best practices to docs/tutorials/
  • Include common error patterns and fixes (e.g., "Task was destroyed but it is pending")
  • Show proper async context management patterns
  • Add examples of correct async patterns for multi-turn interactions
  • Reference working examples from the codebase

Metadata

Metadata

Assignees

No one assigned

    Labels

    community-requestIssue reported or requested by someone from the communitydocumentationImprovements to documentationusabilityimprovements to user experience

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions