Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all examples details and links in examples.md #250

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EnggQasim
Copy link
Contributor

@EnggQasim EnggQasim commented Mar 19, 2025

Title: Enhance example.md: Add Direct Links to Example Topics and Sub-Topics

Description:

This pull request updates the example.md file to include direct links to each example topic and its corresponding sub-topics within the repository. By providing these links, users can navigate more efficiently to specific examples, enhancing the overall usability of the documentation.

Changes Introduced:

  • Agent Patterns:

    • Added links to examples demonstrating common agent design patterns, such as agents as tools, deterministic workflows, and parallel agent execution.
  • Basic:

    • Included links to foundational SDK capabilities, including dynamic system prompts, streaming outputs, and lifecycle events.
  • Tools:

    • Provided links to implementations of OpenAI-hosted tools like web search and file search, and guidance on integrating them into agents.
  • Model Providers:

    • Linked to examples illustrating the use of non-OpenAI models with the SDK.
  • Handoffs:

    • Added links to practical examples of agent handoffs.
  • Customer Service and Research Bot:

    • Inserted links to more comprehensive examples that illustrate real-world applications, such as a customer service system for an airline and a simple deep research clone.

Benefits:

  • Improves navigation within the example.md, allowing users to quickly access specific examples.
  • Enhances the clarity and organization of the documentation.
  • Facilitates a better understanding of the SDK's capabilities through direct access to relevant examples.

Testing:

  • Verified that each link directs to the correct example file or directory within the repository.
  • Ensured that the example.md renders correctly with the new links.

Additional Notes:

  • No functional code changes are introduced in this pull request; it solely focuses on documentation enhancement.

By merging this pull request, we aim to provide users with a more intuitive and efficient way to explore the examples provided in the repository.

@rm-openai pls review it :)

Update all examples details and links in examples.md
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.

1 participant