Skip to content

docs(readme): announce /v1 GA and name the baseline version - #798

Merged
jiashuoz merged 1 commit into
mainfrom
docs/readme-ga-announcement
Aug 2, 2026
Merged

docs(readme): announce /v1 GA and name the baseline version#798
jiashuoz merged 1 commit into
mainfrom
docs/readme-ga-announcement

Conversation

@jiashuoz

@jiashuoz jiashuoz commented Aug 2, 2026

Copy link
Copy Markdown
Member

The README claimed GA but never said since which release — while docs/api.md and SECURITY.md both name 1.5.0. A reader couldn't tell whether GA had actually shipped or was aspirational, nor which tag to pin against.

Changes

A release badge and a one-line announcement above the nav:

/v1 is now generally available — shipped in v1.5.0.

Names the version in the stability callout, and adds the fact a consumer actually needs — that the tag is the compatibility baseline later releases are audited against:

The core /v1 API and SDKs are stable and generally available (GA) as of v1.5.0: no breaking changes within /v1. That tag is the compatibility baseline — every later release is audited against it.

The beta enumeration is untouched.

Verification

  • Release badge renders v1.5.0 (fetched the shield, not assumed)
  • releases/tag/v1.5.0 → 200, releases/latest → 200

Related

Companion to #797, which moves the compatibility-gate audit baseline from the pre-release freeze anchor to v1.5.0 — the same fact, stated where the gate's operator will look for it.

🤖 Generated with Claude Code

The README already claimed GA but never said since WHICH release, while
docs/api.md and SECURITY.md both name 1.5.0. A reader could not tell
whether GA had actually shipped or was aspirational, nor which tag to
pin against.

- Adds a release badge and a one-line announcement above the nav.
- Names v1.5.0 in the stability callout and states that it is the
  compatibility baseline every later release is audited against, which
  is the fact a consumer actually needs.

Verified: badge renders v1.5.0, and both release links return 200.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@jiashuoz
jiashuoz merged commit e498f8c into main Aug 2, 2026
3 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.

1 participant