Skip to content

Commit d1fc1f6

Browse files
committed
docs: 移除空壳板块(academy/architecture/research/playbook/contributing)
1 parent c329a57 commit d1fc1f6

24 files changed

Lines changed: 51 additions & 1060 deletions

docs/.vitepress/config.ts

Lines changed: 35 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const base = rawBase
1010
: '/'
1111

1212
const siteTitle = 'C++ 高性能指南'
13-
const siteDescription = '可运行的 C++ 性能工程文档,覆盖学院、架构、实践手册、参考资料与研究内容。'
13+
const siteDescription = '可运行的 C++ 性能工程文档,覆盖入门、指南、深度专题、算法、练习与参考。'
1414
const siteUrl = 'https://lessup.github.io'
1515
const canonicalBase = '/cpp-high-performance-guide/'
1616
const currentYear = new Date().getFullYear()
@@ -25,72 +25,46 @@ function canonicalAssetUrl(path: string): string {
2525
return new URL(`${canonicalBase.replace(/^\/+/, '')}${normalizedPath}`, `${siteUrl}/`).toString()
2626
}
2727

28-
const zhAcademyItems = [
29-
{ text: '学院概览', link: '/zh/academy/' },
30-
{ text: '模块总览', link: '/zh/academy/module-atlas' },
31-
{ text: '验证原则', link: '/zh/academy/validation-doctrine' },
32-
]
33-
34-
const zhArchitectureItems = [
35-
{ text: '架构概览', link: '/zh/architecture/' },
36-
{ text: '仓库拓扑', link: '/zh/architecture/repository-topology' },
37-
{ text: '性能方法论', link: '/zh/architecture/performance-methodology' },
28+
const zhGettingStartedItems = [
29+
{ text: '先决条件', link: '/zh/getting-started/prerequisites' },
30+
{ text: '安装指南', link: '/zh/getting-started/installation' },
31+
{ text: '快速开始', link: '/zh/getting-started/quickstart' },
3832
]
3933

40-
const zhPlaybookItems = [
41-
{ text: '实践手册概览', link: '/zh/playbook/' },
42-
{ text: '快速开始', link: '/zh/getting-started/quickstart' },
43-
{ text: '安装指南', link: '/zh/getting-started/installation' },
44-
{ text: '先决条件', link: '/zh/getting-started/prerequisites' },
34+
const zhGuidesItems = [
4535
{ text: '学习路径', link: '/zh/guides/learning-path' },
4636
{ text: '性能分析指南', link: '/zh/guides/profiling-guide' },
4737
{ text: '验证与 Sanitizer', link: '/zh/guides/validation' },
4838
{ text: '优化决策树', link: '/zh/guides/optimization-decision-tree' },
4939
{ text: '最佳实践', link: '/zh/guides/best-practices' },
5040
]
5141

52-
const zhReferenceItems = [
53-
{ text: '参考概览', link: '/zh/reference/' },
54-
{ text: 'API 入口', link: '/zh/reference/api-reference' },
55-
{ text: '内存工具', link: '/zh/reference/api/memory-utils' },
56-
{ text: 'SIMD Wrapper', link: '/zh/reference/api/simd-wrapper' },
57-
{ text: 'Benchmark 工具', link: '/zh/reference/api/benchmark-utils' },
58-
{ text: '常见问题', link: '/zh/reference/faq' },
59-
{ text: '故障排查', link: '/zh/reference/troubleshooting' },
60-
]
61-
62-
const zhResearchItems = [
63-
{ text: '研究概览', link: '/zh/research/' },
64-
{ text: '相关工作', link: '/zh/research/related-work' },
65-
{ text: '参考资料', link: '/zh/research/references' },
66-
{ text: '演进记录', link: '/zh/research/evolution' },
67-
]
68-
69-
const zhContributingItems = [
70-
{ text: 'AI 开发流程', link: '/zh/contributing/ai-workflow' },
42+
const zhDeepDivesItems = [
43+
{ text: '内存布局', link: '/zh/deep-dives/memory-layout' },
44+
{ text: '无锁队列', link: '/zh/deep-dives/lock-free-queue' },
45+
{ text: 'SIMD 内部机制', link: '/zh/deep-dives/simd-internals' },
7146
]
7247

7348
const zhAlgorithmsItems = [
74-
{ text: '算法概览', link: '/zh/algorithms/' },
7549
{ text: '排序算法', link: '/zh/algorithms/sorting' },
7650
{ text: '哈希算法', link: '/zh/algorithms/hashing' },
7751
]
7852

79-
const zhDeepDivesItems = [
80-
{ text: '深度专题概览', link: '/zh/deep-dives/' },
81-
{ text: '内存布局', link: '/zh/deep-dives/memory-layout' },
82-
{ text: '无锁队列', link: '/zh/deep-dives/lock-free-queue' },
83-
{ text: 'SIMD 内部机制', link: '/zh/deep-dives/simd-internals' },
84-
]
85-
8653
const zhExerciseItems = [
87-
{ text: '练习总览', link: '/zh/exercises/' },
8854
{ text: '内存练习', link: '/zh/exercises/module-02-memory' },
8955
{ text: 'SIMD 练习', link: '/zh/exercises/module-04-simd' },
9056
{ text: '并发练习', link: '/zh/exercises/module-05-concurrency' },
9157
{ text: '解答', link: '/zh/exercises/solutions' },
9258
]
9359

60+
const zhReferenceItems = [
61+
{ text: '内存工具', link: '/zh/reference/api/memory-utils' },
62+
{ text: 'SIMD Wrapper', link: '/zh/reference/api/simd-wrapper' },
63+
{ text: 'Benchmark 工具', link: '/zh/reference/api/benchmark-utils' },
64+
{ text: '常见问题', link: '/zh/reference/faq' },
65+
{ text: '故障排查', link: '/zh/reference/troubleshooting' },
66+
]
67+
9468
export default withMermaid(defineConfig({
9569
title: siteTitle,
9670
description: siteDescription,
@@ -123,7 +97,7 @@ export default withMermaid(defineConfig({
12397
['meta', { name: 'twitter:image', content: canonicalAssetUrl('/og-card.png') }],
12498
['meta', { name: 'twitter:title', content: siteTitle }],
12599
['meta', { name: 'twitter:description', content: siteDescription }],
126-
['meta', { name: 'keywords', content: 'C++, 性能, 学院, 架构, 实践手册, 参考, 研究, SIMD, 并发, CMake, 基准测试' }],
100+
['meta', { name: 'keywords', content: 'C++, 性能, SIMD, 并发, CMake, 基准测试, 内存布局, 无锁队列' }],
127101
],
128102
locales: {
129103
zh: {
@@ -142,14 +116,12 @@ export default withMermaid(defineConfig({
142116
copyright: `版权所有 © ${currentYear} C++ HPC Guide 贡献者`,
143117
},
144118
nav: [
145-
{ text: '学院', link: '/zh/academy/', activeMatch: '/zh/academy/' },
146-
{ text: '架构', link: '/zh/architecture/', activeMatch: '/zh/architecture/' },
147-
{ text: '算法', link: '/zh/algorithms/', activeMatch: '/zh/algorithms/' },
148-
{ text: '实践手册', link: '/zh/playbook/', activeMatch: '/zh/playbook/|/zh/getting-started/|/zh/guides/' },
149-
{ text: '深度专题', link: '/zh/deep-dives/', activeMatch: '/zh/deep-dives/' },
150-
{ text: '参考', link: '/zh/reference/', activeMatch: '/zh/reference/' },
151-
{ text: '研究', link: '/zh/research/', activeMatch: '/zh/research/' },
152-
{ text: '贡献', link: '/zh/contributing/ai-workflow', activeMatch: '/zh/contributing/' },
119+
{ text: '入门', link: '/zh/getting-started/quickstart', activeMatch: '/zh/getting-started/' },
120+
{ text: '指南', link: '/zh/guides/learning-path', activeMatch: '/zh/guides/' },
121+
{ text: '深度专题', link: '/zh/deep-dives/memory-layout', activeMatch: '/zh/deep-dives/' },
122+
{ text: '算法', link: '/zh/algorithms/sorting', activeMatch: '/zh/algorithms/' },
123+
{ text: '练习', link: '/zh/exercises/module-02-memory', activeMatch: '/zh/exercises/' },
124+
{ text: '参考', link: '/zh/reference/faq', activeMatch: '/zh/reference/' },
153125
],
154126
sidebar: {
155127
'/zh/': [
@@ -160,41 +132,29 @@ export default withMermaid(defineConfig({
160132
],
161133
},
162134
{
163-
text: '学院',
164-
items: zhAcademyItems,
135+
text: '入门',
136+
items: zhGettingStartedItems,
165137
},
166138
{
167-
text: '架构',
168-
items: zhArchitectureItems,
169-
},
170-
{
171-
text: '算法',
172-
items: zhAlgorithmsItems,
173-
},
174-
{
175-
text: '实践手册',
176-
items: zhPlaybookItems,
139+
text: '指南',
140+
items: zhGuidesItems,
177141
},
178142
{
179143
text: '深度专题',
180144
items: zhDeepDivesItems,
181145
},
182146
{
183-
text: '参考',
184-
items: zhReferenceItems,
185-
},
186-
{
187-
text: '研究',
188-
items: zhResearchItems,
189-
},
190-
{
191-
text: '贡献',
192-
items: zhContributingItems,
147+
text: '算法',
148+
items: zhAlgorithmsItems,
193149
},
194150
{
195151
text: '练习',
196152
items: zhExerciseItems,
197153
},
154+
{
155+
text: '参考',
156+
items: zhReferenceItems,
157+
},
198158
],
199159
},
200160
docFooter: {

docs/.vitepress/tests/whitepaper-content.test.mjs

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,6 @@ function read(relativePath) {
1414
test('Chinese whitepaper pages do not contain placeholder markers', () => {
1515
for (const relativePath of [
1616
'zh/index.md',
17-
'zh/academy/index.md',
18-
'zh/academy/module-atlas.md',
19-
'zh/academy/validation-doctrine.md',
20-
'zh/architecture/index.md',
21-
'zh/architecture/repository-topology.md',
22-
'zh/architecture/performance-methodology.md',
23-
'zh/playbook/index.md',
24-
'zh/reference/index.md',
25-
'zh/research/index.md',
26-
'zh/research/related-work.md',
27-
'zh/research/references.md',
28-
'zh/research/evolution.md',
2917
]) {
3018
const content = read(relativePath)
3119
assert.doesNotMatch(content, //)

docs/zh/academy/index.md

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

docs/zh/academy/module-atlas.md

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

docs/zh/academy/validation-doctrine.md

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

0 commit comments

Comments
 (0)