Skip to content

docs(AIC-3760): add the experimental features section to the README - #275

Open
jeffdupont wants to merge 1 commit into
mainfrom
jdupont/aic-3760-readme-experimental-block
Open

jeffdupont wants to merge 1 commit into
mainfrom
jdupont/aic-3760-readme-experimental-block

Conversation

@jeffdupont

@jeffdupont jeffdupont commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Adds an Experimental features section to the root README. It lists the SDK's experimental features, what each one does, where to import it from, and its changelog scope. It sits between two generated markers, so it can be refreshed when a feature joins, changes or is promoted, instead of edited by hand.

Changes

  • README.md: added the experimental-features start and end markers after Packages, with the generated section between them. It has one row, Shadow requests (imported from launchdarkly_ai_server.experimental.shadow_requests, changelog scope shadow-requests), and links to the Shadow requests section of packages/client/README.md.

Regenerated

Regenerated from the final experimental-features source; the output was unchanged. Evaluations from Code is core, as packages/client/README.md and the changelog say from 1.0.0, so Shadow requests is the only experimental feature listed.

Test plan

  • The section is the generator's output, unedited, and regenerating it leaves the file unchanged.
  • The link anchor exists: ### Shadow requests (experimental) in packages/client/README.md.

🤖 Generated with Claude Code


Note

Overview
Adds a generated Experimental features section to the root README, placed after Versioning and before Quick Start. The block sits between experimental-features:start / experimental-features:end markers so it can be regenerated when experimental APIs change, instead of being maintained manually.

The section explains that experimental APIs may change in minor releases and points readers to Experimental changelog entries. It currently documents one capability—Shadow requests—with a short description, import path (launchdarkly_ai_server.experimental.shadow_requests), changelog scope (shadow-requests), and a link to the client package docs.

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

List the SDK's experimental features in the root README between generated
markers, so the section is refreshed rather than edited by hand.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jeffdupont
jeffdupont marked this pull request as ready for review November 4, 2026 20:50
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