docs: clarify private preview SDK access in README#1875
Open
jar-stripe wants to merge 1 commit into
Open
Conversation
Committed-By-Agent: claude
jar-stripe
requested review from
Copilot and
xavdid
and removed request for
a team
There was a problem hiding this comment.
Pull request overview
Updates the README’s “Private Preview SDKs” section to clarify that anyone can install -alpha.X gem versions, while access to specific private preview API features may still require separate approval—reducing confusion about “invite-only” wording.
Changes:
- Removes “invite-only” framing that could be interpreted as restricting SDK installation.
- Explicitly notes that approvals apply to certain private preview API features, not the ability to install the
-alpha.XSDK.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Why?
The private preview SDK section previously said "These are invite-only features. Once invited, you can install..." — implying users need an invitation to install the SDK. In reality, anyone can install the
-alpha.XSDK versions. It's only the private preview API features that may require separate access approval.This corrects the framing so developers aren't confused or discouraged from installing the SDK when they see "invite-only."
What?
See Also