Merged
Conversation
There was a problem hiding this comment.
📝 README Overhaul ‑ Review Summary
Great work tightening up the SDK README! The new structure, badges and modernised examples substantially improve developer onboarding.
✅ What Looks Good
| Area | Observation |
|---|---|
| Organisation | Clear intro, badges, and logical TOC |
| Installation | Accurate pip, Poetry and UV commands |
| Usage Examples | Sync & async patterns shown with practical Pydantic model |
| Streaming Docs | Concise SSE explanation with context manager |
💡 Minor Suggestions (non-blocking)
- Add
from pydantic import BaseModelbefore declaringclass RoomDescriptionfor zero-friction copy-paste. - Consider showing
export OPPER_API_KEY=...rather than embedding the key in code for best practice.
No blocking issues detected. Approving.
— agentobot[bot]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.