Skip to content

Conversation

rajephon
Copy link
Collaborator

Summary

This PR fixes two key documentation inconsistencies that could confuse users:

  • Model name consistency: Updated documentation examples to use gpt-5-mini instead of gpt-4o-mini to match the model used in example.py and README.md
  • Callback event accuracy: Corrected documentation to accurately reflect which callback events are supported by each streaming type, rather than incorrectly suggesting all types support the same events uniformly

Changes Made

Model Name Consistency

  • Updated docs/index.md and docs/api/parser.md to use gpt-5-mini in code examples
  • Ensures consistency across all documentation and example code

Callback Event Documentation

  • Fixed inaccurate descriptions in README.md, docs/index.md, and docs/api/overview.md
  • Added detailed explanations in docs/api/parser.md showing which events are supported by each type:
    • Object: on_start, on_complete, on_update
    • List: on_start, on_complete, on_append
    • String: on_start, on_complete, on_append
    • Atom: on_start, on_complete

Test plan

  • All existing tests pass
  • Documentation builds without errors
  • Code examples in documentation are accurate and consistent

Correct the documentation to accurately reflect which callback events
are supported by each streaming type:
- Object: on_start, on_complete, on_update
- List: on_start, on_complete, on_append
- String: on_start, on_complete, on_append
- Atom: on_start, on_complete

Previously, documentation incorrectly suggested all types support
on_append, on_update, and on_complete uniformly.
@rajephon rajephon changed the title fix: documentation inconsistenciesFix docs inconsistencies fix: documentation inconsistencies Aug 20, 2025
@rajephon rajephon force-pushed the fix-docs-inconsistencies branch from df0787c to ae18548 Compare August 20, 2025 08:10
Copy link
Collaborator

@dittos dittos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@dittos dittos merged commit c35437d into globalaiplatform:main Aug 20, 2025
2 checks passed
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.

2 participants