Skip to content

docs(rtc-node): remove outdated Developer Preview notice from README - #718

Merged
xianshijing-lk merged 1 commit into
mainfrom
sxian/readme-remove-dev-preview
Sep 8, 2026
Merged

docs(rtc-node): remove outdated Developer Preview notice from README#718
xianshijing-lk merged 1 commit into
mainfrom
sxian/readme-remove-dev-preview

Conversation

@xianshijing-lk

Copy link
Copy Markdown
Contributor

Problem

The @livekit/rtc-node README still opens with:

This SDK is currently in Developer Preview mode and not ready for production use. There will be bugs and APIs may change during this period.

This came up from a customer (via support) who noticed the mismatch between that label and the package's actual status. They're right — it's stale:

  • The package has shipped regular releases since 2024 and is currently at 0.13.34.
  • @livekit/agents v1.8.0 declares @livekit/rtc-node: ^0.13.34 as a peer dependency, so anyone running the Node Agents SDK is already depending on it.

Because this text renders on npmjs.com, it's the first thing evaluating customers read.

Change

Removes the notice block. This matches livekit/python-sdks, whose realtime SDK README has no equivalent banner (and never did — git log -S "Developer Preview" on that repo is empty); it goes straight from the description into usage.

The "we welcome feedback / #dev channel" line that lived in the same blockquote is dropped too, since the Getting help / Contributing section at the bottom of this README already says the same thing — again matching the Python repo's structure.

Deliberately not replacing it with a "production ready" claim. That reads as a support commitment and invites follow-up questions about documented scale limits, which is a product/DevRel call rather than a README change.

Includes a patch changeset so the corrected README gets republished to npm.

Note for reviewers

Node @livekit/rtc-node is still 0.13.x while Python livekit-rtc is at 1.1.17. I considered keeping a short "not yet 1.0, breaking changes may land in minor versions" caveat to reflect that, but opted for consistency with the Python README. Happy to add it back if you'd rather be explicit about the 0.x contract.

🤖 Generated with Claude Code

The README stated the SDK was "in Developer Preview mode and not ready
for production use". That has not been accurate for some time: the
package has shipped regular releases since 2024 (currently 0.13.x) and
@livekit/agents declares @livekit/rtc-node as a peer dependency.

Removes the notice block entirely to match the Python realtime SDK
README, which has no such banner. The feedback/Slack line it contained
is already covered by the "Getting help / Contributing" section at the
bottom of this README.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Sep 8, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 88eadcf

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@livekit/rtc-node Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@xianshijing-lk
xianshijing-lk merged commit 8c55a31 into main Sep 8, 2026
10 checks passed
@xianshijing-lk
xianshijing-lk deleted the sxian/readme-remove-dev-preview branch September 8, 2026 21:38
@github-actions github-actions Bot mentioned this pull request Sep 6, 2026
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