docs: update the README warning from no-releases to early-release - #48
Merged
Conversation
The warning still claimed there are no releases while the same README links to the v0.1.0 binaries; reframe as pre-1.0 with no stability guarantees.
Kiran01bm
marked this pull request as ready for review
August 19, 2026 23:40
Kiran01bm
requested review from
JashLal,
aparajon,
eeSeeGee,
jayjanssen,
jemiahw and
morgo
as code owners
August 19, 2026 23:40
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
JashLal
approved these changes
Aug 20, 2026
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
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
The README warning block still says "There are no releases" while the Install section of the same README links to the v0.1.0 binaries on the releases page. Reframe the warning as early-release: tagged releases exist, but pre-1.0 carries no stability guarantees or support, and interfaces may change between releases. The don't-run-this-on-a-database-you-care-about caveat stays.
What
One hunk in
README.md— the[!WARNING]admonition. Docs-only; no code changes.Why
A first-time visitor reads a contradiction in the first ten lines: a hard "no releases" claim followed by install-from-releases instructions. The warning should gate expectations, not contradict the release we shipped.