Skip to content

Commit 83cc365

Browse files
committed
docs: comprehensive documentation refactor and v1.3.0 release
Major Changes: - Restructured docs/ with hierarchical organization (getting-started/, guides/, reference/, contributing/) - Complete bilingual (EN/ZH) documentation parity - New quickstart, installation, and prerequisites guides - Added best practices and API reference documentation - Professionalized changelog format with standardized release notes New Documentation: - docs/en/ and docs/zh/ index pages for language selection - Getting started guides for both languages - Platform-specific installation instructions - Best practices guides with code examples - API reference documentation Updates: - Updated SUMMARY.md with new structure - Updated CHANGELOG.md with v1.3.0 entry - Created v1.3.0 release notes in changelog/ - Bump version to 1.3.0 in CMakeLists.txt Release: v1.3.0 Phoenix
1 parent f8443a2 commit 83cc365

30 files changed

Lines changed: 2247 additions & 777 deletions

CHANGELOG.md

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,36 @@
22

33
All notable changes to this project will be documented in this file.
44

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).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
76

87
## [Unreleased]
98

9+
## [1.3.0] - 2026-04-16
10+
11+
### Major Changes
12+
- Comprehensive documentation restructure with hierarchical organization
13+
- Complete bilingual (EN/ZH) documentation parity
14+
- Professional changelog format with standardized release notes
15+
- New getting-started guides (quickstart, installation, prerequisites)
16+
1017
### Added
11-
- Comprehensive FAQ guides (English & Chinese)
12-
- Troubleshooting guides (English & Chinese)
13-
- GitHub issue/PR templates
14-
- Security policy and Code of Conduct
15-
- Helper scripts (build.sh, test.sh, format.sh, setup.sh)
16-
- .editorconfig for consistent coding style
18+
- New `docs/` structure: `getting-started/`, `guides/`, `reference/`, `contributing/`
19+
- Landing pages for English and Chinese documentation
20+
- Quick start guides for both languages
21+
- Platform-specific installation guides (Ubuntu, Fedora, macOS, Windows/WSL)
22+
- Prerequisites documentation with knowledge and system requirements
23+
- Best practices guides with code examples
24+
- API reference documentation
1725

1826
### Changed
19-
- Reorganized documentation structure
20-
- Moved CLAUDE.md to docs/developers/claude-guide.md
21-
- Moved package files to docs/ subdirectory
22-
- Updated gitbook-sync guides
23-
24-
### Fixed
25-
- All workflow branch references (main → master)
26-
- npm cache configuration in pages.yml
27-
- Changelog file naming consistency
27+
- Updated SUMMARY.md with new documentation paths
28+
- Professionalized changelog format with metadata and categories
29+
- Improved navigation between bilingual content
2830

29-
---
31+
### Documentation
32+
- Complete restructuring for better discoverability
33+
- Cross-linked bilingual content
34+
- Enhanced getting started experience
3035

3136
## [1.2.0] - 2026-04-15
3237

@@ -49,8 +54,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4954
- All internal documentation links
5055
- Workflow branch references to use correct default branch (master)
5156

52-
---
53-
5457
## [1.1.0] - 2026-03-13
5558

5659
### Added
@@ -66,13 +69,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6669
- Standardized documentation information architecture
6770
- Clarified entry point responsibilities
6871

69-
---
70-
7172
## [1.0.2] - 2026-03-10
7273

7374
### Added
7475
- package.json and package-lock.json for HonKit version locking
75-
- npm cache support in pages workflow
76+
- npm cache support in pages workflow for faster builds
7677
- Sparse-checkout for efficient CI builds
7778

7879
### Changed
@@ -83,8 +84,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8384
- Docs badge link pointing to correct workflow file
8485
- Reduced CI checkout time by excluding unnecessary directories
8586

86-
---
87-
8887
## [1.0.1] - 2026-03-06
8988

9089
### Added
@@ -104,8 +103,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
104103
- SIMD dispatch template design (separate template parameters)
105104
- Property test entry point ordering
106105

107-
---
108-
109106
## [1.0.0] - 2026-02-27
110107

111108
### Added
@@ -126,8 +123,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
126123
- MSVC compatibility in simd_utils.hpp
127124
- CMakeLists.txt registration for atomic and OpenMP benchmarks
128125

129-
---
130-
131126
## [0.1.0] - 2026-01-09
132127

133128
### Added
@@ -147,7 +142,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
147142

148143
---
149144

150-
[Unreleased]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.2.0...HEAD
145+
[Unreleased]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.3.0...HEAD
146+
[1.3.0]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.2.0...v1.3.0
151147
[1.2.0]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.1.0...v1.2.0
152148
[1.1.0]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.0.2...v1.1.0
153149
[1.0.2]: https://github.com/LessUp/cpp-high-performance-guide/compare/v1.0.1...v1.0.2

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cmake_minimum_required(VERSION 3.20)
22

33
project(hpc-optimization-guide
4-
VERSION 1.0.0
4+
VERSION 1.3.0
55
DESCRIPTION "High Performance Computing Optimization Guide - Modern C++ Examples"
66
LANGUAGES CXX
77
)

0 commit comments

Comments
 (0)