Skip to content

Commit 4d282bb

Browse files
committed
chore: cleanup stale files and update documentation
- Remove openspec workflow files and AGENTS.md - Consolidate AI guidance into CLAUDE.md - Update bilingual documentation - Add CHANGELOG.md
1 parent 61c86c4 commit 4d282bb

45 files changed

Lines changed: 107 additions & 1745 deletions

File tree

Some content is hidden

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

.github/copilot-instructions.md

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

AGENTS.md

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

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [1.3.0] - 2025-05
6+
7+
### Added
8+
- Runtime SIMD dispatch module with AVX-512/AVX2/SSE2 fallback (`include/hpc/simd.hpp`)
9+
- Header-only safety hardening across all modules
10+
- Benchmark comparison tool with Markdown report generation (`tools/performance/benchmark_compare.py`)
11+
12+
### Changed
13+
- VitePress documentation redesign with Quantum Cobalt theme
14+
- Bilingual homepage landing flow improvements
15+
- Consolidated AI guidance into single `CLAUDE.md` file
16+
- Removed OpenSpec workflow for simplified maintenance
17+
18+
## [1.0.0] - 2024
19+
20+
### Added
21+
- Initial project structure with CMake preset-driven builds
22+
- Memory and cache optimization examples (AOS/SOA, false sharing, alignment, prefetch)
23+
- Modern C++ performance patterns (constexpr, move semantics, ranges)
24+
- SIMD vectorization examples (auto-vectorization, SSE/AVX intrinsics)
25+
- Concurrency examples (atomics, lock-free queue, OpenMP)
26+
- VitePress bilingual documentation site (English + Chinese)
27+
- Google Test and RapidCheck testing frameworks
28+
- Google Benchmark integration
29+
- Sanitizer presets (ASAN, TSAN, UBSAN)

CLAUDE.md

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,8 @@
11
# CLAUDE.md
22

3-
## Mission
4-
5-
Help finish this repository cleanly. Prioritize hardening, consistency, and removal of stale surfaces over feature expansion.
6-
73
## Project position
84

9-
This repository is in **closure and hardening mode** (archive-ready for low-frequency maintenance).
10-
11-
## Working style
12-
13-
1. Read the relevant capability specs in `openspec/specs/`.
14-
2. Work inside an OpenSpec change under `openspec/changes/`.
15-
3. Prefer aggressive cleanup when a file or workflow is stale, duplicated, or no longer part of the final repo story.
16-
4. Keep user-facing guidance aligned across:
17-
- `README.md`
18-
- `README.zh-CN.md`
19-
- `docs/`
20-
- `AGENTS.md`
21-
- `.github/copilot-instructions.md`
22-
5. Use `/review` before merge or after a large cleanup phase.
5+
This repository is in **closure and hardening mode** (archive-ready for low-frequency maintenance). Prefer normalization, defect fixing, and removal of stale or low-signal surfaces over adding new features.
236

247
## C++ Standards and Style
258

@@ -28,16 +11,26 @@ This repository is in **closure and hardening mode** (archive-ready for low-freq
2811
- **Memory safety**: prefer RAII, smart pointers, avoid raw `new/delete`
2912
- **Performance**: always measure with benchmarks before claiming improvement
3013
- **Concurrency**: use `std::atomic` with explicit memory ordering
14+
- **Header-only design**: all library code in `include/hpc/` and `examples/*/include/` is header-only. Platform-specific code is hidden behind preprocessor conditionals within headers.
15+
16+
## Repository layout
17+
18+
```text
19+
cpp-high-performance-guide/
20+
├── CMakeLists.txt
21+
├── CMakePresets.json
22+
├── cmake/
23+
├── examples/
24+
├── tests/
25+
├── benchmarks/
26+
├── tools/
27+
├── scripts/
28+
├── docs/ # VitePress site and bilingual learning docs
29+
├── .githooks/ # Project-managed Git hooks
30+
└── .github/
31+
```
3132

32-
## Project facts
33-
34-
- Docs stack: **VitePress**, published via GitHub Pages
35-
- Build system: **CMake + presets**
36-
- Language server: **clangd** — configured via `.clangd` at repo root (`CompilationDatabase: build/debug`); all CMake presets export `compile_commands.json` via `CMAKE_EXPORT_COMPILE_COMMANDS=ON`
37-
- Primary maintenance target: **Linux**
38-
- Repo posture: **archive-ready / low-frequency maintenance**
39-
40-
## Commands
33+
## Standard commands
4134

4235
```bash
4336
# Build and test
@@ -58,9 +51,30 @@ cmake --preset=release && cmake --build build/release
5851
./scripts/setup-hooks.sh
5952
```
6053

61-
## Process expectations
54+
## Engineering rules
55+
56+
- Prefer **deleting or archiving stale content** instead of preserving redundant surfaces.
57+
- Keep **README** focused on repository entry and onboarding; use the docs site for the richer narrative.
58+
- 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.
60+
- Use **CMake presets** as the default build and test entry points.
61+
- Keep workflows **preset-driven, low-noise, and meaningful**.
62+
- Avoid over-engineering with extra plugins, MCP servers, or automation layers unless they clearly reduce maintenance cost.
63+
64+
## AI tooling policy
65+
66+
- **CLAUDE.md**: Claude Code specific guidance (this file).
67+
- **LSP**: prefer `clangd` backed by `compile_commands.json`. The `.clangd` config at the repo root points `CompilationDatabase` to `build/debug`.
68+
- **Review model**: use `/review` before merge or after major cleanup phases.
69+
70+
## Editor integration
71+
72+
The `.vscode/` directory is **gitignored**. Use `.clangd`, `.editorconfig`, and `CMakePresets.json` for machine-readable project conventions.
73+
74+
## Things to avoid reintroducing
6275

63-
- Do not add new generic documentation just to fill space.
64-
- Do not reintroduce GitBook / HonKit / `.kiro` assumptions.
65-
- Keep workflows meaningful; delete low-value automation rather than preserving it.
66-
- Prefer one long-running implementation session to quota-heavy parallelism unless the work clearly benefits from it.
76+
- HonKit / GitBook-era configuration
77+
- `.kiro/`-style legacy spec structures
78+
- duplicate changelog surfaces with no maintenance value
79+
- non-blocking CI steps that hide real failures
80+
- generic AI instructions that do not reflect this repository

CONTRIBUTING.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ ctest --preset=debug
1818

1919
## Default workflow
2020

21-
1. Read the relevant capability specs in `openspec/specs/`.
22-
2. Create or update one change under `openspec/changes/<change-id>/`.
23-
3. Implement tasks in dependency order.
24-
4. Keep docs, specs, and code in sync.
25-
5. Run the required validation commands.
26-
6. Use `/review` before merge for non-trivial work.
27-
7. Archive the change after completion.
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.
2824

2925
## Validation commands
3026

@@ -69,9 +65,4 @@ The repository hooks currently enforce:
6965

7066
## Need the AI workflow?
7167

72-
See:
73-
74-
- `AGENTS.md`
75-
- `CLAUDE.md`
76-
- `.github/copilot-instructions.md`
77-
- `docs/en/contributing/ai-workflow.md`
68+
See `CLAUDE.md` for Claude Code specific guidance.

CONTRIBUTING.zh.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ ctest --preset=debug
1818

1919
## 默认开发流程
2020

21-
1. 先阅读 `openspec/specs/` 中相关的 capability spec。
22-
2.`openspec/changes/<change-id>/` 下创建或更新一个 change。
23-
3. 按任务依赖顺序实施。
24-
4. 保持 docs、specs 与代码同步。
25-
5. 运行要求的验证命令。
26-
6. 对非 trivial 修改在合并前使用 `/review`
27-
7. 完成后归档该 change。
21+
1. 保持文档与代码同步。
22+
2. 运行要求的验证命令。
23+
3. 对非 trivial 修改在合并前使用 `/review`
2824

2925
## 验证命令
3026

@@ -69,9 +65,4 @@ cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan
6965

7066
## 如果你需要 AI 开发流程
7167

72-
参见:
73-
74-
- `AGENTS.md`
75-
- `CLAUDE.md`
76-
- `.github/copilot-instructions.md`
77-
- `docs/zh/contributing/ai-workflow.md`
68+
参见 `CLAUDE.md`

README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Every major topic is meant to be **readable, buildable, and measurable**.
4343
| `examples/04-simd-vectorization/` | auto-vectorization, intrinsics, SIMD wrappers |
4444
| `examples/05-concurrency/` | atomics, lock-free queue, OpenMP |
4545
| `docs/` | bilingual Pages whitepaper covering academy, architecture, playbook, reference, research |
46-
| `openspec/` | spec-driven development workflow and change history |
4746

4847
## Quick start
4948

@@ -89,23 +88,6 @@ cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan
8988
- **Validation & sanitizers:** [`docs/en/guides/validation.md`](docs/en/guides/validation.md)
9089
- **Chinese entry:** `README.zh-CN.md` and `docs/zh/`
9190

92-
## Development workflow
93-
94-
This repository uses **OpenSpec** for non-trivial changes.
95-
96-
1. Read the affected capability specs in `openspec/specs/`.
97-
2. Create or update a change under `openspec/changes/<change-id>/`.
98-
3. Implement tasks in dependency order.
99-
4. Run preset-driven validation.
100-
5. Use `/review` before merge for non-trivial work.
101-
6. Archive completed changes.
102-
103-
The repository also keeps AI tool guidance in:
104-
105-
- `AGENTS.md`
106-
- `CLAUDE.md`
107-
- `.github/copilot-instructions.md`
108-
10991
## Tech stack
11092

11193
- **Language:** C++20

README.zh-CN.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
| `examples/04-simd-vectorization/` | 自动向量化、intrinsics、SIMD 封装 |
4444
| `examples/05-concurrency/` | 原子操作、无锁队列、OpenMP |
4545
| `docs/` | 双语 Pages 白皮书,覆盖学院 / 架构 / 实践手册 / 参考 / 研究 |
46-
| `openspec/` | 规格驱动开发流程与 change 历史 |
4746

4847
## 快速开始
4948

@@ -90,23 +89,6 @@ cmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan
9089
- **验证与 Sanitizer:** [`docs/zh/guides/validation.md`](docs/zh/guides/validation.md)
9190
- **英文入口:** `README.md``docs/en/`
9291

93-
## 开发流程
94-
95-
本仓库对非 trivial 修改使用 **OpenSpec**
96-
97-
1. 先阅读 `openspec/specs/` 中受影响的 capability spec。
98-
2.`openspec/changes/<change-id>/` 下创建或更新一个 change。
99-
3. 按任务依赖顺序实施。
100-
4. 使用 preset 驱动的命令做验证。
101-
5. 非 trivial 修改在合并前使用 `/review`
102-
6. 完成后归档 change。
103-
104-
仓库也为 AI 工具保留了明确说明:
105-
106-
- `AGENTS.md`
107-
- `CLAUDE.md`
108-
- `.github/copilot-instructions.md`
109-
11092
## 技术栈
11193

11294
- **语言:** C++20

0 commit comments

Comments
 (0)