/ CHANGELOG.md
CHANGELOG.md
1 # Changelog 2 3 All notable changes to this project will be documented in this file. 4 5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), 6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 8 --- 9 10 ## [Unreleased] 11 12 ### Planned 13 - Additional module documentation translations 14 - Video tutorial series 15 - Interactive examples 16 17 --- 18 19 ## [1.0.0] - 2026-04-16 20 21 ### 🌐 Bilingual Documentation 22 23 #### English 24 Complete documentation refactoring with professional English + Chinese versions, separate directory structure (`docs/en/` and `docs/zh/`), and full VitePress i18n support. 25 26 #### 中文 27 完整的文档重构，提供专业化中英文版本，独立的目录结构（`docs/en/` 和 `docs/zh/`），以及完整的 VitePress 国际化支持。 28 29 ### ✨ Highlights 30 31 #### English 32 - **Documentation Restructure**: 10 documents split into 22 bilingual files 33 - **Changelog Standardization**: Adopted Keep a Changelog format with SemVer 34 - **VitePress i18n**: Full multilingual navigation and search 35 - **Professional Format**: Consistent structure across all languages 36 37 #### 中文 38 - **文档重构**: 10 个文档拆分为 22 个双语文件 39 - **更新日志标准化**: 采用 Keep a Changelog 格式，遵循语义化版本 40 - **VitePress 国际化**: 完整的多语言导航和搜索 41 - **专业化格式**: 所有语言一致的文档结构 42 43 ### 🔄 Changes 44 45 #### Added 46 - `docs/en/` - Complete English documentation suite (10 files) 47 - `docs/zh/` - Complete Chinese documentation suite (10 files) 48 - `docs/README.md` - Documentation navigation index 49 - `changelog/archive/` - Version archive with standardized format 50 - `changelog/v1.0.0.md` - First SemVer release notes 51 52 #### Changed 53 - **Documentation Structure**: From flat mixed-language to hierarchical i18n 54 - **Changelog Format**: From date-named to Semantic Versioning 55 - **VitePress Config**: Added `locales` for multilingual support 56 - **README**: Updated links to new documentation structure 57 58 #### Deprecated 59 - Old mixed-language documentation format 60 - Date-named changelog files (superseded by SemVer) 61 62 #### Removed 63 - Single-directory doc structure (`docs/*.md` mixed format) 64 65 ### 📊 Statistics 66 67 | Metric | Before | After | 68 |--------|--------|-------| 69 | Documentation files | 10 | 22 (+120%) | 70 | Languages supported | Mixed | Full EN + ZH | 71 | Document organization | Flat | Hierarchical | 72 | Changelog standard | Date-named | SemVer + Keep a Changelog | 73 74 ### 📚 Documentation 75 76 #### English Documents 77 - [Quick Start](docs/en/quick-start.md) 78 - [Prerequisites](docs/en/prerequisites.md) 79 - [Architecture](docs/en/architecture.md) 80 - [API Reference](docs/en/api-reference.md) 81 - [Performance Tuning](docs/en/performance-tuning.md) 82 - [Troubleshooting](docs/en/troubleshooting.md) 83 - [Learning Path](docs/en/learning-path.md) 84 - [Contributing](docs/en/contributing.md) 85 - [Glossary](docs/en/glossary.md) 86 - [References](docs/en/references.md) 87 88 #### 中文文档 89 - [快速开始](docs/zh/quick-start.md) 90 - [前置要求](docs/zh/prerequisites.md) 91 - [项目架构](docs/zh/architecture.md) 92 - [API 参考](docs/zh/api-reference.md) 93 - [性能调优](docs/zh/performance-tuning.md) 94 - [问题排查](docs/zh/troubleshooting.md) 95 - [学习路线](docs/zh/learning-path.md) 96 - [贡献指南](docs/zh/contributing.md) 97 - [术语表](docs/zh/glossary.md) 98 - [参考资料](docs/zh/references.md) 99 100 ### 🔄 Migration 101 102 #### For Users 103 - Update documentation bookmarks: 104 - Old: `/docs/quick-start` 105 - New: `/docs/en/quick-start` or `/docs/zh/quick-start` 106 107 #### For Contributors 108 - Edit files in appropriate language directory: 109 - English: `docs/en/` 110 - Chinese: `docs/zh/` 111 112 ### 🔗 Archive 113 114 Historical changelogs available in [changelog/archive/](changelog/archive/): 115 - [v1.0.0](changelog/archive/v1.0.0.md) - Bilingual documentation 116 - [v0.3.0](changelog/archive/v0.3.0.md) - Bug fixes & JSON serialization 117 - [v0.2.0](changelog/archive/v0.2.0.md) - Project infrastructure 118 - [v0.1.0](changelog/archive/v0.1.0.md) - Initial setup 119 120 --- 121 122 ## Version History Summary 123 124 | Version | Date | Key Changes | Status | 125 |---------|------|-------------|--------| 126 | v1.0.0 | 2026-04-16 | Bilingual docs, changelog standardization | **Stable** | 127 | v0.3.0 | 2026-02-24 | Bug fixes, JSON serialization, Windows scripts | Legacy | 128 | v0.2.0 | 2026-02-13 | Project infrastructure, CI enhancement | Legacy | 129 | v0.1.0 | 2026-01-08 | Initial project setup | Legacy | 130 131 --- 132 133 ## Release Notes 134 135 ### English 136 This release marks the transition from beta to stable, with comprehensive bilingual documentation support. The project is now suitable for: 137 - Educational use in universities 138 - Corporate training programs 139 - Self-directed learning 140 - Research reference 141 142 ### 中文 143 此版本标志着从测试版到稳定版的过渡，提供全面的双语文档支持。项目现在适用于： 144 - 高校教学使用 145 - 企业培训项目 146 - 自主学习 147 - 研究参考 148 149 --- 150 151 For detailed changes in each version, see individual files in `changelog/archive/`.