Skip to content

Conversation

@rbren
Copy link
Contributor

@rbren rbren commented Oct 30, 2025

Summary

This PR adds a prominent alpha software warning to the top of the README to clearly communicate that this TypeScript SDK is currently in alpha and not stable.

Changes

  • Added a visually prominent warning section at the top of the README
  • Included specific warnings about:
    • Potential breaking changes in any release
    • Incomplete features and possible bugs
    • Outdated or incomplete documentation
    • Not recommended for production use
  • Used clear formatting with warning emojis and blockquotes for visibility

Motivation

Since this is an alpha version of the TypeScript SDK, it's important to set proper expectations for users about the stability and maturity of the software. This warning helps prevent users from using it in production environments where stability is critical.

Testing

  • Verified the warning displays correctly in the README
  • Confirmed the formatting renders properly in markdown

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (please describe):

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

@rbren can click here to continue refining the PR

- Add prominent warning at top of README indicating this is alpha software
- Warn users about potential breaking changes and instability
- Advise against production use
- Include specific warnings about incomplete features and documentation
@rbren rbren marked this pull request as ready for review October 30, 2025 18:34
@rbren rbren merged commit 91f4077 into main Oct 30, 2025
5 checks passed
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.

3 participants