docs: add API stability documentation to README #2589
Conversation
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
Added comprehensive API stability documentation categorizing all modules: - Stable: Identity, Wallet, Transaction, Swap, Fund, Token - Evolving: Buy, Earn, NFT, MiniKit - Experimental: Appchain Bridge, Signature - Deprecated: Checkout, MiniKitProvider Helps developers understand which APIs are production-ready and which may change. Closes coinbase#2577
|
@devacc8 is attempting to deploy a commit to the Coinbase Team on Vercel. A member of the Team first needs to authorize it. |
🟡 Heimdall Review Status
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Added comprehensive API stability documentation to both README files, categorizing all modules into stability tiers.
API Stability Categories
✅ Stable
Production-ready APIs following semantic versioning:
⚡ Evolving
Stable but may receive non-breaking enhancements:
🧪 Experimental
May change significantly:
Scheduled for removal:
Transactioncomponent insteadOnchainKitProviderwithminiKitpropWhy This Matters
Developers need clarity on which APIs are safe for production use. This documentation helps them make informed decisions about which components to adopt.
Closes #2577