Skip to content

docs: reference Semantic Versioning (semver.org) in version standards#66

Merged
JusterZhu merged 1 commit into
mainfrom
docs/semver-references
Jun 3, 2026
Merged

docs: reference Semantic Versioning (semver.org) in version standards#66
JusterZhu merged 1 commit into
mainfrom
docs/semver-references

Conversation

@JusterZhu

Copy link
Copy Markdown
Collaborator

Summary

Add Semantic Versioning references to version-related documentation sections, using language-appropriate URLs for Chinese and English audiences.

Changes

website/docs/doc/Component Introduction.md (base)

  • Add SemVer as the primary version standard recommendation
  • Explain 4-part .NET versioning (Major.Minor.Build.Revision) as a SemVer extension
  • Keep NuGet/Assembly versioning links as supplementary .NET references
  • Use https://semver.org/ for English content

website/i18n/zh-Hans/.../Component Introduction.md

  • Use https://semver.org/lang/zh-CN/ for Chinese audience
  • Explain the relationship between SemVer 3-part and .NET 4-part versioning in Chinese

website/i18n/en/.../Component Introduction.md

  • Mirror the English SemVer reference consistently

Validation

  • npm run build -- --no-minify passes
  • Links verified: semver.org and semver.org/lang/zh-CN/ are live

- Add Semantic Versioning (semver.org) link as primary version standard
- Extend explanation to cover 4-part .NET version compatibility
- Use language-appropriate URLs:
  - Chinese (zh-Hans): https://semver.org/lang/zh-CN/
  - English: https://semver.org/
- Keep NuGet and Assembly versioning links as supplementary references

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 1, 2026 04:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates versioning documentation to reference Semantic Versioning while clarifying the project’s .NET-compatible four-part version format.

Changes:

  • Adds SemVer references to English and Chinese component introduction docs.
  • Clarifies MAJOR.MINOR.PATCH.REVISION as a .NET System.Version compatibility extension.
  • Updates English Microsoft documentation links from Chinese locale to English locale.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
website/docs/doc/Component Introduction.md Adds SemVer guidance and English .NET versioning links.
website/i18n/en/docusaurus-plugin-content-docs/current/doc/Component Introduction.md Mirrors the English documentation updates for localized docs.
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/Component Introduction.md Adds Chinese SemVer guidance and keeps Chinese reference links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

GeneralUpdate 遵循[语义化版本](https://semver.org/lang/zh-CN/)规范的核心原则(`MAJOR.MINOR.PATCH`),并基于 .NET `System.Version` 兼容性扩展了第四个 `Revision` 段(`MAJOR.MINOR.PATCH.REVISION`)。

- 语义化版本规范:https://semver.org/lang/zh-CN/
- Nuget 版本管理参考标准:https://docs.microsoft.com/zh-cn/nuget/concepts/package-versioning
@JusterZhu JusterZhu merged commit 8ad8c4b into main Jun 3, 2026
2 checks passed
@JusterZhu JusterZhu deleted the docs/semver-references branch June 3, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants