Update AI SDK README#507
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Updates the AI SDK README to clarify ownership and migration status, adjust release phase naming, and refine wording around API stability.
- Splits and clarifies the introduction sentence about Jetify’s maintenance and migration plan.
- Renames the “v1 Release” phase to “General Availability (v1)”.
- Improves grammar in the API stability note.
Comments suppressed due to low confidence (1)
aisdk/ai/README.md:17
- [nitpick] Consider merging this and the following line into a single paragraph or rephrasing to improve readability, e.g.:
"It is maintained and developed by Jetify and is being adopted as the primary SDK for our AI agents in production."
It is maintained and developed by [Jetify](https://www.jetify.com). We are in the process of migrating our production code
| - [ ] General Availability (v1): Ready for production use at scale with guaranteed API stability. | ||
|
|
||
| We are currently in **Public Alpha**. The SDK functionality is stable but it's API may have breaking changes. While in alpha, minor version bumps indicate breaking changes (`0.1.0` -> `0.2.0` would indicate a breaking change). Watch "releases" of this repo to get notified of major updates. | ||
| We are currently in **Public Alpha**. The SDK functionality is stable but the API may have breaking changes. While in alpha, minor version bumps indicate breaking changes (`0.1.0` -> `0.2.0` would indicate a breaking change). Watch "releases" of this repo to get notified of major updates. |
There was a problem hiding this comment.
For clarity and consistency, consider using the possessive form "its API" instead of "the API":
"…but its API may have breaking changes."
Suggested change
| We are currently in **Public Alpha**. The SDK functionality is stable but the API may have breaking changes. While in alpha, minor version bumps indicate breaking changes (`0.1.0` -> `0.2.0` would indicate a breaking change). Watch "releases" of this repo to get notified of major updates. | |
| We are currently in **Public Alpha**. The SDK functionality is stable but its API may have breaking changes. While in alpha, minor version bumps indicate breaking changes (`0.1.0` -> `0.2.0` would indicate a breaking change). Watch "releases" of this repo to get notified of major updates. |
savil
approved these changes
Jun 3, 2025
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.
Summary
Update AI SDK README.
How was it tested?
N/A
Community Contribution License
All community contributions in this pull request are licensed to the project maintainers under the terms of the Apache 2 License.
By creating this pull request I represent that I have the right to license the contributions to the project maintainers under the Apache 2 License as stated in the Community Contribution License.