Skip to content

docs: sync examples.md with current examples directory#2827

Merged
seratch merged 1 commit intoopenai:mainfrom
AbdullahBapra:docs/update-examples-md
Apr 2, 2026
Merged

docs: sync examples.md with current examples directory#2827
seratch merged 1 commit intoopenai:mainfrom
AbdullahBapra:docs/update-examples-md

Conversation

@AbdullahBapra
Copy link
Copy Markdown
Contributor

Updates docs/examples.md to accurately document all examples currently in the codebase. Several new examples were added to the repository but not reflected in the documentation.

Changes

Added documentation for:

  • agent_patterns: agents as tools streaming/structured, forcing tool use, human-in-the-loop (base + streaming)
  • basic: tools.py, tool input/output guardrails, image tool output, lifecycle hooks example
  • handoffs: message filter with streaming
  • hosted_mcp: expanded from a generic description to individual entries (simple, connectors, HITL, on_approval)
  • mcp: 6 new sub-examples (SSE remote, Streamable HTTP remote, custom HTTP client, get_all_tools, MCPServerManager, tool filter)
  • memory: 5 new entries (file-backed session, file HITL, SQLite in-memory HITL, OpenAI Conversations HITL, HITL scenario)
  • reasoning_content: expanded to list runner_example, gpt_oss_stream, and main individually
  • tools: apply_patch, shell, shell with HITL

No functional code changes

This is a documentation-only update.

Add missing examples across all categories including agent_patterns
(HITL, forcing tool use, structured/streaming agents-as-tools),
basic (tool guardrails, image tool output, lifecycle hooks),
hosted_mcp (individual file descriptions), mcp (6 new sub-examples),
memory (HITL and file session examples), reasoning_content (individual
files), tools (apply_patch, shell, shell HITL), and handoffs (streaming).
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 1, 2026
@seratch seratch merged commit f75a40e into openai:main Apr 2, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants