Skip to content

Update root, core, and ai package READMEs with correct types and examples#176

Merged
ClickerMonkey merged 4 commits intomainfrom
copilot/update-readmes-for-root-core-ai
Apr 3, 2026
Merged

Update root, core, and ai package READMEs with correct types and examples#176
ClickerMonkey merged 4 commits intomainfrom
copilot/update-readmes-for-root-core-ai

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

  • Update root README.md per issue requirements
  • Update packages/core/README.md - fix types and add readme links
  • Update packages/ai/README.md - fix types and add readme links
    • Add // or .stream(request, ctx?) comments to image.edit, image.analyze, transcribe, and speech APIs
    • Replace ASCII architecture diagram with mermaid
  • Replace ASCII architecture diagram with mermaid in root README.md

Copilot AI changed the title [WIP] Update root, core, and AI package readmes Update root, core, and ai package READMEs with correct types and examples Apr 3, 2026
Copilot AI requested a review from ClickerMonkey April 3, 2026 04:15
Comment thread packages/ai/README.md
ai.chat.get(request, ctx?) // or .stream(request, ctx?)
ai.image.generate.get(request, ctx?) // or .stream(request, ctx?)
ai.image.edit.get(request, ctx?)
ai.image.edit.stream(request, ctx?)
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Why remove the stream references? At least add as comment after get

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added // or .stream(request, ctx?) comments to all streaming-capable APIs (image.edit, image.analyze, transcribe, speech) in commit 953154c. embed was intentionally left without the comment since it doesn't support streaming.

@ClickerMonkey ClickerMonkey marked this pull request as ready for review April 3, 2026 10:41
@ClickerMonkey ClickerMonkey merged commit 5d43ce2 into main Apr 3, 2026
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.

Update root, core, and ai package readmes

2 participants