Skip to content

docs: add deprecation notice to README - #241

Merged
maxkahan merged 4 commits into
masterfrom
docs/archive-notice
Oct 29, 2026
Merged

maxkahan merged 4 commits into
masterfrom
docs/archive-notice

Conversation

@maxkahan

@maxkahan maxkahan commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Replaces the maintenance-mode notice at the top of the README with a deprecation notice. stream-chat-python stays open. The notice tells new projects to use stream-py and 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 deprecates stream-chat-python instead of describing it as maintenance-mode only. A top [!CAUTION] block states the SDK is legacy, tells new projects not to use it, points to getstream / stream-py, and links the migration guide (URL updated to the main tree path).

Branding is adjusted so the repo reads as legacy: the main heading and hero copy say Legacy rather than Official, the centered logo is removed, and the tagline no longer presents this as the current SDK.

Reviewed by Cursor Bugbot for commit d8a9d7e. Bugbot is set up for automated code reviews on this repo. Configure here.

@maxkahan
maxkahan force-pushed the docs/archive-notice branch from ab01e9f to 76cf769 Compare October 14, 2026 12:57
@maxkahan maxkahan changed the title docs: add archive notice to README docs: add deprecation notice to README Oct 14, 2026
@maxkahan
maxkahan merged commit 1675a55 into master Oct 29, 2026
8 of 10 checks passed
@maxkahan
maxkahan deleted the docs/archive-notice branch October 29, 2026 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants