Skip to content

docs: match READMEs and AGENTS.md to the released versions - #303

Draft
jeffdupont wants to merge 1 commit into
mainfrom
jdupont/docs-release-gate
Draft

jeffdupont wants to merge 1 commit into
mainfrom
jdupont/docs-release-gate

Conversation

@jeffdupont

Copy link
Copy Markdown
Contributor

Several READMEs and agent guides still describe the SDK as it was before 1.0. This brings them in line with the released packages, and adds a release rule so it doesn't happen again.

What changed

  • Experimental features: packages/client/agents.md names shadow requests (launchdarkly_ai_server.experimental.shadow_requests) as the one experimental feature instead of "No feature is experimental now".
  • Breaking experimental changes at 1.x: AGENTS.md and packages/client/agents.md no longer describe the 0.x ! / minor-bump rule. At 1.x a ! forces a major release, so a breaking change to an experimental feature ships in a minor release with its feature scope. The API compatibility check skips experimental modules.
  • Versions: README.md no longer says every package is released at the same version. Packages are versioned on their own, all on major 1, with >=1.x,<2 ranges on the core package.
  • LiteLLM: the "Experimental … stays on 0.x" banner is removed from both LiteLLM READMEs. Both packages are stable 1.x packages.
  • launchdarkly-ai-python: its README no longer says it "does not pin" the server. It requires launchdarkly-ai-server>=1.0.0,<2.
  • Upgrade caveats in packages/client/README.md: the "upgrade both" caveats are replaced. With pip's default upgrade strategy, upgrading launchdarkly-ai-python from 0.x brings the server to 1.x (tested with pip 26.2.2). The shadow-requests note, which needs server 1.1.0, is kept.

Release rule

AGENTS.md ("PR Titles and the Changelog") gains a rule: before a release PR merges, every README (root and every package), AGENTS.md, example, install line and maturity banner must match the version being released, with grep evidence in the release PR.

Docs only.

🤖 Generated with Claude Code

The versioning notes describe per-package 1.x versions, the LiteLLM
READMEs lose the 0.x banner, and the client agents.md names shadow
requests as the one experimental feature. launchdarkly-ai-python 1.x
requires launchdarkly-ai-server>=1.0.0,<2, so the "does not pin" and
"upgrade both" notes for Agent Skills and Evaluations from Code are
replaced. AGENTS.md now says how a breaking experimental change ships
at 1.x and adds a docs check for release PRs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

1 participant