Skip to content

[codex] docs: promote README version cleanup to main - #545

Merged
jeremymcs merged 1 commit into
mainfrom
chore/backmerge-promote-543-main
May 31, 2026
Merged

jeremymcs merged 1 commit into
mainfrom
chore/backmerge-promote-543-main

Conversation

@jeremymcs

@jeremymcs jeremymcs commented May 31, 2026 •

Copy link
Copy Markdown
Member

Summary

Closes #542

  • Promote the README version-source cleanup from merged PR [codex] docs: align README version source of truth #543 onto main.
  • Cherry-picks the exact docs changes so main gets the npm/package metadata source-of-truth wording without pulling unrelated next changes.
  • Uses the allowed chore/backmerge-* branch pattern for a main-targeted promotion PR.

Root Cause

PR #543 landed on next, but the same README version-conflict cleanup is needed on main so public stable documentation does not continue showing stale legacy release/current-stream signals.

Validation

  • git diff --check HEAD~1..HEAD
  • GITHUB_BASE_REF=main 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
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-core on npm / package.json is canonical while docs/ 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 pinned RELEASE-v1.42.x entries, retargets What’s new / preview quick links to latest / next npm 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.

@jeremymcs
jeremymcs merged commit 1411b6b into main May 31, 2026
47 of 57 checks passed
@jeremymcs
jeremymcs deleted the chore/backmerge-promote-543-main branch May 31, 2026 15:42
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.

1 participant