Repository navigation
[codex] docs: align README version source of truth - #543
Merged
Merged
Conversation
jeremymcs
marked this pull request as ready for review
May 31, 2026 15:32
This was referenced May 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #542
@opengsd/gsd-core@latest/package.jsonas the current package version source of truth.Root Cause
The README surface had inherited legacy release-note references from the pre-current package line, while
@opengsd/gsd-core@latestandpackage.jsonnow identify the active package version. That made the docs print conflicting version signals.Validation
npm view @opengsd/gsd-core version dist-tags --jsonconfirmedlatest: 1.2.0andnext: 1.2.0-rc.1.git diff --checkGITHUB_BASE_REF=next npm run lint:docs -- --jsonNeed help on this PR? Tag
@codesmithwith 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.jsonis the single current version source, instead of staledocs/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 atlatestandnexton npm.Reviewed by Cursor Bugbot for commit c6724ea. Bugbot is set up for automated code reviews on this repo. Configure here.