Skip to content

Commit c329a57

Browse files
docs: 收口为中文唯一文档站,移除英文与双语基础设施
删除 docs/en/ 全部 38 个英文文档、双语切换组件(LanguageSwitcher/ LanguageRedirect/LandingHero)、language-routing/config-helpers 及对应 测试,以及 README.zh-CN.md、CONTRIBUTING.zh.md、TRANSLATION_SCOPE.md、 META.md 等双语维护设施。 重写 README/CONTRIBUTING/CLAUDE/docs 入口为纯中文,docs/zh/index.md 改用 VitePress 原生 home 布局,config.ts 移除 en locale 与 englishReferenceHub。修复 4 个 example README 与 learning-path、 evolution、PR 模板中的英文/双语引用。 文档测试 3/3 通过,vitepress build 成功(40 个 zh/ markdown)。 Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent bb612b5 commit c329a57

70 files changed

Lines changed: 130 additions & 9302 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Brief description of what this PR adds or fixes.
2424
- [ ] ThreadSanitizer (for concurrency code): `cmake --preset=tsan && cmake --build build/tsan && ctest --preset=tsan`
2525
- [ ] UndefinedBehaviorSanitizer: `cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan`
2626
- [ ] I have updated the documentation accordingly (if applicable)
27-
- [ ] Both English and Chinese documentation are updated (if applicable)
2827
- [ ] My changes generate no new warnings
2928
- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable)
3029
- [ ] I ran `/review` or an equivalent review pass for this non-trivial change

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cpp-high-performance-guide/
2525
├── benchmarks/
2626
├── tools/
2727
├── scripts/
28-
├── docs/ # VitePress site and bilingual learning docs
28+
├── docs/ # VitePress site (Chinese only)
2929
├── .githooks/ # Project-managed Git hooks
3030
└── .github/
3131
```
@@ -56,7 +56,7 @@ cmake --preset=release && cmake --build build/release
5656
- Prefer **deleting or archiving stale content** instead of preserving redundant surfaces.
5757
- Keep **README** focused on repository entry and onboarding; use the docs site for the richer narrative.
5858
- Treat **GitHub Pages** as a project landing page, not a thin README mirror.
59-
- Keep user-facing documentation **English + Chinese** where the surface is meant to be bilingual.
59+
- Documentation is **Chinese only**. Do not reintroduce English documentation surfaces.
6060
- Use **CMake presets** as the default build and test entry points.
6161
- Keep workflows **preset-driven, low-noise, and meaningful**.
6262
- Avoid over-engineering with extra plugins, MCP servers, or automation layers unless they clearly reduce maintenance cost.
@@ -76,4 +76,4 @@ The `.vscode/` directory is **gitignored**. Use `.clangd`, `.editorconfig`, and
7676
- non-blocking CI steps that hide real failures
7777
- per-example shim headers that only re-export a canonical `include/hpc/` header
7878
- wrapper scripts that duplicate `cmake --preset` commands
79-
- English-only documentation surfaces (all bilingual surfaces must have zh parity)
79+
- English documentation surfaces or bilingual parity machinery

CONTRIBUTING.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing
1+
# 参与贡献
22

3-
Thanks for contributing. This repository prefers **spec-driven, low-noise changes** over broad, loosely scoped edits.
3+
感谢你的贡献。这个仓库更偏好 **规格驱动、低噪声** 的修改,而不是范围松散的大改。
44

5-
## First-time setup
5+
## 首次配置
66

77
```bash
88
git clone https://github.com/<your-username>/cpp-high-performance-guide.git
@@ -14,15 +14,15 @@ cmake --build build/debug
1414
ctest --preset=debug
1515
```
1616

17-
`./scripts/setup.sh` checks the local toolchain and configures repository-managed Git hooks through `.githooks/`.
17+
`./scripts/setup.sh` 会检查本地工具链,并通过 `.githooks/` 配置仓库自带的 Git hooks。
1818

19-
## Default workflow
19+
## 默认开发流程
2020

21-
1. Keep docs and code in sync.
22-
2. Run the required validation commands.
23-
3. Use `/review` before merge for non-trivial work.
21+
1. 保持文档与代码同步。
22+
2. 运行要求的验证命令。
23+
3. 对非 trivial 修改在合并前使用 `/review`
2424

25-
## Validation commands
25+
## 验证命令
2626

2727
```bash
2828
cmake --preset=debug && cmake --build build/debug && ctest --preset=debug
@@ -33,36 +33,35 @@ cmake --preset=tsan && cmake --build build/tsan && ctest --preset=tsan
3333
cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan
3434
```
3535

36-
The `tsan` preset is standardized on **Clang** because it is the most reliable ThreadSanitizer path for this repository.
36+
`tsan` preset 默认走 **Clang**,这是当前仓库里最稳定的 ThreadSanitizer 路径。
3737

38-
## Formatting and hooks
38+
## 格式化与 hooks
3939

4040
```bash
4141
./scripts/format.sh
4242
./scripts/format.sh --check
4343
./scripts/setup-hooks.sh
4444
```
4545

46-
The repository hooks currently enforce:
46+
当前 hooks 会做这些事情:
4747

48-
- no generated build or docs artifacts in commits
49-
- formatting checks for staged C++ files
50-
- a debug build/test pass on push
48+
- 拒绝提交生成的构建产物或 docs 产物
49+
- staged C++ 文件做格式检查
50+
- push 前执行一次 debug build/test
5151

52-
## Documentation rules
52+
## 文档规则
5353

54-
- Keep root README files concise and entry-focused.
55-
- Treat `docs/` as the richer narrative surface.
56-
- Keep user-facing English and Chinese entry points aligned.
57-
- Do not reintroduce GitBook / HonKit / `.kiro` references.
54+
- 根 README 保持简洁,专注仓库入口。
55+
- `docs/` 承担更完整的叙事与学习路径。
56+
- 不要重新引入 GitBook / HonKit / `.kiro` 引用。
5857

59-
## Process rules
58+
## 流程规则
6059

61-
- Prefer deleting or archiving stale content over preserving it in active paths.
62-
- Keep workflow additions justified and repository-specific.
63-
- Avoid long-lived branch sprawl; one focused branch or PR per change is preferred.
64-
- Do not merge non-trivial structural work without review.
60+
- 对过时内容,优先删除或归档,而不是继续留在主路径。
61+
- 新增 workflow 或工程化配置前,要能说明其项目特定价值。
62+
- 避免同时维护大量长期分支;一个 change 对应一个聚焦分支或 PR 更合适。
63+
- trivial 的结构性修改不要跳过 review
6564

66-
## Need the AI workflow?
65+
## 如果你需要 AI 开发流程
6766

68-
See `CLAUDE.md` for Claude Code specific guidance.
67+
参见 `CLAUDE.md`

CONTRIBUTING.zh.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

README.md

Lines changed: 36 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# C++ High Performance Guide
1+
# C++ 高性能指南
22

33
<p align="center">
44
<a href="https://github.com/LessUp/cpp-high-performance-guide/stargazers">
@@ -13,38 +13,38 @@
1313
</p>
1414

1515
<p align="center">
16-
<b>English</b> | <a href="README.zh-CN.md">简体中文</a> | <a href="https://lessup.github.io/cpp-high-performance-guide/">GitHub Pages</a> | <a href="https://github.com/LessUp/cpp-high-performance-guide/discussions">Discussions</a>
16+
<a href="https://lessup.github.io/cpp-high-performance-guide/">文档站</a> | <a href="https://github.com/LessUp/cpp-high-performance-guide/discussions">讨论</a>
1717
</p>
1818

1919
<p align="center">
20-
Learn measurable C++20 performance engineering through runnable examples, benchmarks, and a VitePress-powered learning site.
20+
通过可运行示例、基准测试和 VitePress 文档站,学习可验证的现代 C++20 性能工程。
2121
</p>
2222

23-
## Why this repository exists
23+
## 这个仓库解决什么问题
2424

25-
This project is a practical guide to common C++ performance topics that are easy to talk about but harder to validate:
25+
关注那些"很容易被谈论、但不容易被验证"的 C++ 性能主题:
2626

27-
- modern CMake and preset-driven builds
28-
- memory and cache layout decisions
29-
- modern C++ performance patterns
30-
- SIMD and vectorization
31-
- concurrency and lock-free basics
32-
- profiling and benchmark-driven reasoning
27+
- 现代 CMake preset 驱动的构建流程
28+
- 内存与缓存布局取舍
29+
- 现代 C++ 的性能实践
30+
- SIMD 与向量化
31+
- 并发与无锁基础
32+
- 基于 benchmark 与 profiling 的性能分析
3333

34-
Every major topic is meant to be **readable, buildable, and measurable**.
34+
每个主题都尽量做到 **可阅读、可构建、可测量**
3535

36-
## What you can explore
36+
## 你可以从哪里开始
3737

38-
| Area | What it covers |
38+
| 区域 | 内容 |
3939
| --- | --- |
40-
| `examples/01-cmake-modern/` | modern CMake structure and best practices |
41-
| `examples/02-memory-cache/` | AOS vs SOA, false sharing, alignment, prefetch |
42-
| `examples/03-modern-cpp/` | constexpr, move semantics, reserve, ranges |
43-
| `examples/04-simd-vectorization/` | auto-vectorization, intrinsics, SIMD wrappers |
44-
| `examples/05-concurrency/` | atomics, lock-free queue, OpenMP |
45-
| `docs/` | bilingual Pages whitepaper covering academy, architecture, playbook, reference, research |
40+
| `examples/01-cmake-modern/` | 现代 CMake 结构与反模式 |
41+
| `examples/02-memory-cache/` | AOS vs SOA、伪共享、对齐、预取 |
42+
| `examples/03-modern-cpp/` | constexpr、移动语义、reserveranges |
43+
| `examples/04-simd-vectorization/` | 自动向量化、intrinsicsSIMD 封装 |
44+
| `examples/05-concurrency/` | 原子操作、无锁队列、OpenMP |
45+
| `docs/` | VitePress 文档站,覆盖学院 / 架构 / 实践手册 / 参考 / 研究 |
4646

47-
## Quick start
47+
## 快速开始
4848

4949
```bash
5050
git clone https://github.com/LessUp/cpp-high-performance-guide.git
@@ -54,17 +54,13 @@ cmake --preset=release
5454
cmake --build build/release
5555
```
5656

57-
Run one benchmark:
57+
运行一个 benchmark
5858

5959
```bash
6060
./build/release/examples/02-memory-cache/aos_soa_bench
6161
```
6262

63-
Need the redesigned docs route after the quick start? Start with
64-
[`docs/en/playbook/index.md`](docs/en/playbook/index.md), then continue to
65-
[`docs/en/guides/validation.md`](docs/en/guides/validation.md) for sanitizer-specific guidance.
66-
67-
## Validation commands
63+
## 常用验证命令
6864

6965
```bash
7066
cmake --preset=debug && cmake --build build/debug && ctest --preset=debug
@@ -75,22 +71,21 @@ cmake --preset=tsan && cmake --build build/tsan && ctest --preset=tsan
7571
cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan
7672
```
7773

78-
## Documentation entry points
74+
## 文档入口
7975

80-
- **Docs site:** <https://lessup.github.io/cpp-high-performance-guide/>
81-
- **Playbook:** [`docs/en/playbook/index.md`](docs/en/playbook/index.md)
82-
- **Reference:** [`docs/en/reference/index.md`](docs/en/reference/index.md)
83-
- **Chinese entry:** `README.zh-CN.md` and `docs/zh/`
76+
- **文档站:** <https://lessup.github.io/cpp-high-performance-guide/>
77+
- **实践手册:** [`docs/zh/playbook/index.md`](docs/zh/playbook/index.md)
78+
- **参考:** [`docs/zh/reference/index.md`](docs/zh/reference/index.md)
8479

85-
## Tech stack
80+
## 技术栈
8681

87-
- **Language:** C++20
88-
- **Build:** CMake 3.20+, Ninja
89-
- **Testing:** Google Test, RapidCheck
90-
- **Benchmarking:** Google Benchmark
91-
- **Docs:** VitePress + GitHub Pages
92-
- **Profiling:** perf, FlameGraph, Valgrind, VTune
82+
- **语言:** C++20
83+
- **构建:** CMake 3.20+Ninja
84+
- **测试:** Google TestRapidCheck
85+
- **基准测试:** Google Benchmark
86+
- **文档:** VitePress + GitHub Pages
87+
- **性能分析:** perfFlameGraphValgrindVTune
9388

94-
## Contributing
89+
## 贡献
9590

96-
See `CONTRIBUTING.md` for the contributor workflow and hooks setup.
91+
贡献流程与 hooks 配置见 [`CONTRIBUTING.md`](CONTRIBUTING.md)

0 commit comments

Comments
 (0)