chore: update README with Beta feature warning[]

[Harika Kondur (harikakondur)]

Context

Added a warning about the feature being in Beta.

Summary by Bito

This PR adds a beta feature warning to the README.md file of the Experience Design System SDK to alert users that the feature is currently in Beta and APIs may be unstable.

Detailed Changes

• Added a warning banner in README.md indicating the feature is in Beta with potentially unstable APIs

[bito-code-review]

Code Review Agent Run #9509cf

Actionable Suggestions - 0

Review Details

• Files reviewed - 1 · Commit Range: d1abbfd..d1abbfd

  • README.md
• Files skipped - 0
• Tools

  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at jared.jolton@contentful.com.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[bito-code-review]

Changelist by Bito

This pull request implements the following key changes.

Key Change	Files Impacted	Summary
Documentation - Beta Feature Warning Addition	README.md	Added a beta feature warning banner to the README.md to alert users that the feature is in Beta and APIs may be unstable.

[bito-code-review]

Impact Analysis by Bito

Interaction Diagram

sequenceDiagram
participant Dev as Developer
participant GH as GitHub Repository
participant RM as README.md<br/>🔄 Updated | ●●○ Medium
participant PKG as NPM Package Registry
participant User as SDK User
Note over RM: Beta warning added<br/>to inform users of API instability
Dev->>GH: Push PR with README update
GH->>RM: Update documentation
RM-->>GH: Documentation updated
GH-->>Dev: PR merged
opt Package Publication
GH->>PKG: Publish new version
PKG-->>User: Install/Update SDK
User->>RM: Read updated README
    end

Loading

---

This MR adds a Beta warning banner to the README.md to inform users that the Experience Design System SDK APIs may be unstable. This is a documentation-only change with no code impact. No upstream or downstream dependencies were detected in cross-repo analysis.

Code Paths Analyzed

Impact:
Documentation-only change: Added Beta warning notice to README.md. No functional code changes.

Flow:
N/A - README documentation update only.

Direct Changes (Diff Files):
• README.md [1-5] — Added Beta stability warning banner after the main heading.

Repository Impact:
• Documentation: README now includes Beta status disclaimer to set user expectations about API stability.

Cross-Repository Dependencies:
• None.

Database/Caching Impact:
• None

API Contract Violations:
• None.

Infrastructure Dependencies:
• None.

Testing Recommendations

Frontend Impact:
• None.

Service Integration:
• None.

Data Serialization:
• None.

Privacy Compliance:
• None.

Backward Compatibility:
• None.

OAuth Functionality:
• None

Reliability Testing:
• None

Additional Insights:
• Verify the Beta warning renders correctly in GitHub's markdown viewer.
• Consider if this messaging should also be added to package.json description or CLI help text for consistency.

_{Analysis based on known dependency patterns and edges. Actual impact may vary.}

[bito-code-review]

✅ Review Settings Overridden

Status: Overridden Successfully

Guidelines:

• Accepted:

  • General : Review Posture, Repo Truth And Alignment, Domain Invariants

Note: Extra guidelines beyond 3 general purpose guidelines and 1 language specific guideline per language are not processed. Guidelines are fetched from the source branch.