docs: Enhance core primitive documentation with Tracing and user-friendly definitions #1334
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.
This Pull Request significantly improves the "Core Concepts" section of the documentation, providing a more comprehensive and accessible overview of the SDK's primitives.
The existing documentation for the core primitives was good but could be more descriptive for new users. This update makes the following key changes:
Tracing & Observability
: This critical primitive is now included in the list of core concepts. Its description explains its purpose for debugging complex workflows and optimizing performance.Agents
,Handoffs
,Guardrails
,Sessions
, andTracing
—have been rewritten to be more detailed, clear, and beginner-friendly. The new definitions explain not just what each primitive is, but also its purpose and how it directly benefits the developer.These changes make the documentation more thorough and helpful for developers of all skill levels. I believe this update will significantly improve the initial understanding and onboarding experience for all users of the OpenAI Agents SDK.