Skip to content

Conversation

rm-openai
Copy link
Collaborator

Summary

  • document agents.realtime.model so the RealtimeModel link works
  • include the new file in the documentation navigation

Testing

  • make format
  • make lint
  • make mypy
  • make tests

https://chatgpt.com/codex/tasks/task_i_687fadfee88883219240b56e5abba76a

Copy link
Contributor

Summary

Adds a new docs/ref/realtime/model.md stub and registers it in mkdocs.yml to reinstate the broken “Model” reference link in the Realtime docs.

Review

Looks good to me – restores navigation without touching runtime code.

  • File follows existing pattern (::: agents.realtime.model) so autodoc should render correctly.
  • MkDocs nav entry is placed in alphabetical order with neighbouring pages.
  • CI/doc build should pass; no other impacts expected.

Nice quick fix!


View workflow run

@seratch seratch added the documentation Improvements or additions to documentation label Jul 23, 2025
@rm-openai rm-openai merged commit 46101cb into main Jul 23, 2025
7 of 8 checks passed
@rm-openai rm-openai deleted the codex/fix-broken-link-in-docs branch July 23, 2025 17:34
vcshih pushed a commit to veris-ai/openai-agents-python that referenced this pull request Aug 15, 2025
## Summary
- document `agents.realtime.model` so the RealtimeModel link works
- include the new file in the documentation navigation

## Testing
- `make format`
- `make lint`
- `make mypy`
- `make tests`


------
https://chatgpt.com/codex/tasks/task_i_687fadfee88883219240b56e5abba76a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codex documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants