Skip to content

fix: Update pre-release usage guidance#90

Merged
jsonbailey merged 5 commits intomainfrom
devin/1770764803-update-prerelease-guidance
Feb 11, 2026
Merged

fix: Update pre-release usage guidance#90
jsonbailey merged 5 commits intomainfrom
devin/1770764803-update-prerelease-guidance

Conversation

@jsonbailey
Copy link
Contributor

@jsonbailey jsonbailey commented Feb 10, 2026

Requirements

  • I have added test coverage for new or changed functionality — N/A, documentation-only change
  • I have followed the repository's pull request submission guidelines
  • I have validated my changes against all supported platform versions — N/A, documentation-only change

Related issues

None.

Describe the solution you've provided

Four documentation changes:

  1. Softened pre-release language in packages/sdk/server-ai/README.md: Removed the ⛔️ and ☝️ emoji header lines while keeping the > [!CAUTION] block. Replaced the old alpha warning with the revised pre-release notice:

    This SDK is in pre-release and not subject to backwards compatibility
    guarantees. The API may change based on feedback.

    Pin to a specific minor version and review the changelog before upgrading.

  2. Added a package table to the root README.md: Lists the main SDK package and AI provider packages with PyPI badges and README links, modeled after the js-core monorepo README.

  3. Added pre-release caution blocks to AI provider READMEs (server-ai-openai, server-ai-langchain): These previously had no pre-release notice. Added a > [!CAUTION] block with the same revised template, using "This package" instead of "This SDK".

  4. Restructured root README.md to match the js-core layout: Replaced the "LaunchDarkly overview" section at the top with a short repository description. Moved "LaunchDarkly overview" further down the page (after "Learn more", before "Contributing"), matching the structure used in the js-core root README.

Updates since last revision

  • Updated pinning line from "Pin to a specific minor version to avoid breaking changes." to "Pin to a specific minor version and review the changelog before upgrading." across all three package READMEs.
  • Removed "or semantic versioning" from the caution text (done in a prior revision).

Human review checklist

  • Verify the PyPI badge URL for the OpenAI provider — the provider's own README references launchdarkly-server-sdk-ai-openai-dev (with -dev suffix) while the root table uses launchdarkly-server-sdk-ai-openai (without -dev). Confirm which is correct.
  • Confirm the [changelog](CHANGELOG.md) relative link resolves correctly from each package README on GitHub (each package directory contains its own CHANGELOG.md).
  • Confirm the multi-line > [!CAUTION] blockquote renders correctly on GitHub (blank > line separating the two paragraphs, markdown link inside blockquote).

Additional context


Note

Low Risk
Documentation-only changes with no runtime or API behavior impact; main risk is minor confusion if package names/badge links are incorrect.

Overview
Refreshes documentation messaging to standardize a pre-release caution across the core launchdarkly-server-sdk-ai README and the server-ai-openai/server-ai-langchain provider READMEs, including explicit guidance to pin minor versions and review each package’s CHANGELOG.md before upgrading.

Reworks the root README.md to add a packages table (with PyPI badges and per-package README links) and to move the LaunchDarkly overview section lower on the page in favor of a short repository description up top.

Written by Cursor Bugbot for commit 6855076. This will update automatically on new commits. Configure here.

…README

Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration bot added the devin-pr Pull request created by Devin AI label Feb 10, 2026
devin-ai-integration bot and others added 4 commits February 10, 2026 23:11
Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
Co-Authored-By: jbailey@launchdarkly.com <accounts@sidewaysgravity.com>
@jsonbailey jsonbailey marked this pull request as ready for review February 11, 2026 16:35
@jsonbailey jsonbailey requested a review from a team as a code owner February 11, 2026 16:35
@jsonbailey jsonbailey merged commit 4f986c4 into main Feb 11, 2026
7 checks passed
@jsonbailey jsonbailey deleted the devin/1770764803-update-prerelease-guidance branch February 11, 2026 16:39
@github-actions github-actions bot mentioned this pull request Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devin-pr Pull request created by Devin AI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants