docs: add early preview disclaimer to README#39
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a prominent “early preview / not for production” disclaimer to the repository README to set expectations that the samples depend on an SDK that may change frequently.
Changes:
- Added a GitHub-flavored Markdown
[!CAUTION]admonition near the top ofREADME.md. - Clarified that the SDK/samples are for evaluation only and that breaking changes are expected.
- Added a direct link for feedback via GitHub issues.
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.
Adds a prominent prerelease disclaimer to the repository README, making it clear that the samples use an SDK in early preview, not intended for production use, and that breaking changes should be expected.