Skip to content

[codex] docs: align README version source of truth - #543

Merged
jeremymcs merged 1 commit into
nextfrom
codex/readme-version-alignment
May 31, 2026
Merged

jeremymcs merged 1 commit into
nextfrom
codex/readme-version-alignment

Conversation

@jeremymcs

@jeremymcs jeremymcs commented May 31, 2026 •

Copy link
Copy Markdown
Member

Summary

Closes #542

  • Point the public README at @opengsd/gsd-core@latest / package.json as the current package version source of truth.
  • Reframe archived release-note files and the changelog as continuity history instead of current release guidance.
  • Clean localized README highlight sections and the docs index so stale legacy release and canary-current claims no longer compete with the npm/package metadata.

Root Cause

The README surface had inherited legacy release-note references from the pre-current package line, while @opengsd/gsd-core@latest and package.json now identify the active package version. That made the docs print conflicting version signals.

Validation

  • npm view @opengsd/gsd-core version dist-tags --json confirmed latest: 1.2.0 and next: 1.2.0-rc.1.
  • git diff --check
  • GITHUB_BASE_REF=next npm run lint:docs -- --json
  • Stale README/current-stream grep returned no matches for old release/canary claims.

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag @codesmith with what you need. Autofix is disabled.


Note

Low Risk
Documentation-only wording and link changes; no runtime, auth, or data-handling code paths are modified.

Overview
Aligns public README and docs index copy so npm @opengsd/gsd-core / package.json is the single current version source, instead of stale docs/RELEASE-* or legacy highlight version numbers.

The English README updates the returning-user callout to recommend @latest, replaces the v1.42.1 release-note pointer with canonical-version guidance, and reframes CHANGELOG as history including archived notes. Localized READMEs (ja, ko, pt-BR, zh) rename version-tied highlight sections, drop v1.39.0 / canary workflow bullets, and add the same npm-first version note. docs/README.md removes per-release doc links, marks CANARY as archived maintainer notes, and points “what’s new” / preview streams at latest and next on npm.

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

@jeremymcs
jeremymcs marked this pull request as ready for review May 31, 2026 15:32
@jeremymcs
jeremymcs merged commit e8ba6d2 into next May 31, 2026
29 of 32 checks passed
@jeremymcs
jeremymcs deleted the codex/readme-version-alignment branch May 31, 2026 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: align README version source of truth

1 participant