From 4dd3e210acf3bac0cdb247cc435273f6bd076af1 Mon Sep 17 00:00:00 2001
From: jhills20 <james.hills@openai.com>
Date: Wed, 19 Mar 2025 11:43:09 -0700
Subject: [PATCH] add examples section to docs

---
 docs/examples.md | 33 +++++++++++++++++++++++++++++++++
 mkdocs.yml       |  1 +
 2 files changed, 34 insertions(+)
 create mode 100644 docs/examples.md

diff --git a/docs/examples.md b/docs/examples.md
new file mode 100644
index 00000000..358137d6
--- /dev/null
+++ b/docs/examples.md
@@ -0,0 +1,33 @@
+# Examples
+
+Check out a variety of sample implementations of the SDK in the examples section of the [repo](https://github.com/openai/openai-agents-python/tree/main/examples). The examples are organized into several categories that demonstrate different patterns and capabilities.
+
+
+## Categories
+
+- **agent_patterns**
+  Examples in this category illustrate common agent design patterns, such as:
+  - Deterministic workflows
+  - Agents as tools
+  - Parallel agent execution
+
+- **basic**
+  These examples showcase foundational capabilities of the SDK, such as:
+  - Dynamic system prompts
+  - Streaming outputs
+  - Lifecycle events
+
+- **tool examples**
+  Learn how to implement OAI hosted tools such as web search and file search,
+   and integrate them into your agents.
+
+- **model providers**
+  Explore how to use non-OpenAI models with the SDK.
+
+- **handoffs**
+  See practical examples of agent handoffs.
+
+- **customer_service & research_bot**
+  Two more built-out examples that illustrate real-world applications:
+  - **customer_service**: Example customer service system for an airline.
+  - **research_bot**: Simple deep research clone.
diff --git a/mkdocs.yml b/mkdocs.yml
index 398fb74a..e566b615 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -21,6 +21,7 @@ theme:
 nav:
     - Intro: index.md
     - Quickstart: quickstart.md
+    - Examples: examples.md
     - Documentation:
           - agents.md
           - running_agents.md