[codex] docs: promote README version cleanup to main - #545
Merged
Merged
Conversation
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
main.maingets the npm/package metadata source-of-truth wording without pulling unrelatednextchanges.chore/backmerge-*branch pattern for amain-targeted promotion PR.Root Cause
PR #543 landed on
next, but the same README version-conflict cleanup is needed onmainso public stable documentation does not continue showing stale legacy release/current-stream signals.Validation
git diff --check HEAD~1..HEADGITHUB_BASE_REF=main npm run lint:docs -- --jsonNeed help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.Note
Low Risk
Markdown-only wording and link/index updates; no runtime, install, or auth behavior changes.
Overview
Documentation-only promotion that stops advertising specific repo release numbers (e.g. v1.39.0 / v1.42.x) as the current product version across README (EN + JA/KO/PT/ZH) and
docs/README.md.Localized READMEs rename versioned “highlights” sections to feature highlights, drop links to old GitHub release tags, and add a shared note that
@opengsd/gsd-coreon npm /package.jsonis canonical whiledocs/release files are legacy continuity only. Several locale lists also remove the manual canary workflow bullet so stable docs don’t imply an active canary install path.The English README reframes the “returning user” callout toward
@opengsd/gsd-core@latest(instead of “see CHANGELOG for what’s new”) and replaces the v1.42.1 release-notes pointer in Getting Started with the same canonical-version guidance. The docs index drops pinnedRELEASE-v1.42.xentries, retargets What’s new / preview quick links tolatest/nextnpm tags, and labels CANARY docs as archived maintainer notes.Reviewed by Cursor Bugbot for commit 9ee5631. Bugbot is set up for automated code reviews on this repo. Configure here.