Repository navigation
docs: add deprecation notice to README - #220
Merged
Merged
Conversation
maxkahan
requested review from
JimmyPettersson85,
nijeesh-stream,
shaljam and
vishalnarkhede
as code owners
October 13, 2026 15:35
maxkahan
force-pushed
the
docs/archive-notice
branch
from
October 14, 2026 12:57
5abd7d2 to
60e05bd
Compare
maxkahan
changed the title
maxkahan
force-pushed
the
docs/archive-notice
branch
from
October 14, 2026 13:06
60e05bd to
766a612
Compare
This was referenced Oct 14, 2026
mogita
approved these changes
Oct 19, 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
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.
Replaces the maintenance-mode notice at the top of the README with a deprecation notice.
stream-chat-rubystays open. The notice tells new projects to usegetstream-rubyand links its migration guide.The notice is a red caution block at the very top of the README, with a heading and one line each for: don't start new projects here, use the replacement, and how to migrate. The README title and tagline now say "Legacy" instead of "Official", and the logo is removed so the page no longer looks like a current SDK.
Note
Low Risk
Documentation-only README changes with no runtime or API impact.
Overview
The README now leads with a GitHub
[!CAUTION]block that marksstream-chat-rubyas a deprecated legacy SDK, replacing the earlier “maintenance mode” note. It tells new projects not to use this gem, points togetstream-rubyas the replacement, and links the migration guide (updated URL).Branding is adjusted so the repo reads as legacy: the main heading and center tagline say “Legacy” instead of “Official”, and the logo image block is removed from the hero section.
Reviewed by Cursor Bugbot for commit bfa0b28. Bugbot is set up for automated code reviews on this repo. Configure here.