feat: internationalize release notes — website changelog + English GitHub notes#198
Merged
Conversation
Sync CHANGELOG.md / CHANGELOG.zh-CN.md into the VitePress site (EN root at /changelog, zh at /zh/changelog) through the existing sync-docs pipeline: the language-switcher line is stripped and escaping links (LICENSE / NOTICE) are rewritten to absolute GitHub URLs, same as the guide. Adds a Changelog nav entry per locale and gitignores the generated pages. The download page's "Release notes" link now points at the on-site changelog (per locale) instead of the GitHub release page. First step toward internationalizing release notes: the site becomes the real bilingual venue (VitePress i18n renders per-locale and adapts to the visitor's locale), so the GitHub Release can later drop to a single language and link here. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… changelog The GitHub Release body now injects the English canonical CHANGELOG.md (previously the Chinese mirror) and RELEASE_NOTES.md is fully English. This keeps the Release page single-language and short; the bilingual venue is the website changelog (built from both CHANGELOG files, per-locale rendering), linked from the notes for other-language readers. - release.yml: awk source CHANGELOG.zh-CN.md → CHANGELOG.md; comments/warning updated. - RELEASE_NOTES.md: englishified (preview warning, install, first-launch, license) + a "full changelog (EN & 简体中文): <website>/changelog" line. - packaging-release.md: document the English-injection + website-changelog model. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
huhamhire
added
enhancement
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
1 participant
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.
Internationalizes release notes by moving the bilingual venue to the website and keeping the GitHub Release single-language. Two commits.
1. Website hosts a bilingual changelog page (
6f7c3cf)CHANGELOG.md/CHANGELOG.zh-CN.mdare synced into the VitePress site through the existingsync-docspipeline →/changelog(EN) and/zh/changelog(ZH). The language-switcher line is stripped and escaping links (LICENSE / NOTICE) are rewritten to GitHub, same as the guide.CHANGELOGfiles remain the single source of truth (already kept in sync each release).2. GitHub Release notes → single-language English + link (
9bb6119)release.ymlinjects the English canonicalCHANGELOG.md(was the Chinese mirror), so the Release body is single-language and short.RELEASE_NOTES.mdfully englishified (preview warning, install, first-launch, license) + a line: "Full changelog — every version, in English and 简体中文:<website>/changelog" for other-language readers.packaging-release.mdupdated to document the English-injection + website-changelog model.Why this shape
GitHub Release notes are static server-rendered Markdown — no JS, no
navigator.language, so<details>collapsibles can't adapt to the viewer's locale and full bilingual inline just doubles the length. The website (VitePress i18n) is the venue that renders per-locale and adapts, so bilingual lives there; GitHub stays single-language English (matching the project's English-canonical external surfaces) and links out.Verification
npm run buildinwebsite/passes (sync copies both CHANGELOG files, no dead links, pages render).RELEASE_NOTES.mdhas no residual Chinese;release.ymlinjection source isCHANGELOG.md.🤖 Generated with Claude Code