Skip to content

Commit 2dd68e3

Browse files
docs: restructure GitHub Pages as architecture showcase
- Redesign theme to dark tech style (cyan-violet gradient accents) - Add Technical Whitepaper (en/zh) with academic structure - Add Competitive Analysis with 13x8 feature matrix - Add Algorithmic Theory page with math derivations - Expand References with 15 academic citations + theory - Rebuild nav config with Whitepaper, Comparison, Theory entries - Enhance homepage with "Why fqc?" cards and research context Generated with [Devin](https://cli.devin.ai/docs) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 4054e10 commit 2dd68e3

13 files changed

Lines changed: 2479 additions & 630 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 72 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export default withMermaid(defineConfig({
2525

2626
head: [
2727
['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }],
28-
['meta', { name: 'theme-color', content: '#0e7c6b' }],
28+
['meta', { name: 'theme-color', content: '#06b6d4' }],
2929
['meta', { property: 'og:type', content: 'website' }],
3030
['meta', { property: 'og:site_name', content: 'fqc' }],
3131
['meta', { property: 'og:image', content: '/og-image.svg' }],
@@ -63,6 +63,11 @@ export default withMermaid(defineConfig({
6363
description: '基于 Rust 的块索引 FASTQ 压缩工具',
6464
themeConfig: {
6565
nav: [
66+
{
67+
text: '白皮书',
68+
link: '/zh/whitepaper',
69+
activeMatch: '/zh/whitepaper'
70+
},
6671
{
6772
text: '指南',
6873
activeMatch: '/zh/guide/',
@@ -92,10 +97,12 @@ export default withMermaid(defineConfig({
9297
},
9398
{
9499
text: '参考',
95-
activeMatch: '/zh/(reference|benchmarks|references|release-notes)',
100+
activeMatch: '/zh/(reference|benchmarks|references|release-notes|comparison|theory)',
96101
items: [
97102
{ text: '二进制格式规范', link: '/zh/reference/format-spec' },
98103
{ text: '基准测试', link: '/zh/benchmarks/performance-report' },
104+
{ text: '竞品对比', link: '/zh/comparison' },
105+
{ text: '理论基础', link: '/zh/theory' },
99106
{ text: '参考文献', link: '/zh/references/' },
100107
{ text: '发布说明', link: '/zh/release-notes' }
101108
]
@@ -163,6 +170,30 @@ export default withMermaid(defineConfig({
163170
{ text: '参考文献与相关工作', link: '/zh/references/' }
164171
]
165172
}
173+
],
174+
'/zh/whitepaper': [
175+
{
176+
text: '技术白皮书',
177+
items: [
178+
{ text: '概述', link: '/zh/whitepaper' }
179+
]
180+
}
181+
],
182+
'/zh/comparison': [
183+
{
184+
text: '竞品对比',
185+
items: [
186+
{ text: '对比分析', link: '/zh/comparison' }
187+
]
188+
}
189+
],
190+
'/zh/theory': [
191+
{
192+
text: '理论基础',
193+
items: [
194+
{ text: '算法理论', link: '/zh/theory' }
195+
]
196+
}
166197
]
167198
}
168199
}
@@ -175,6 +206,11 @@ export default withMermaid(defineConfig({
175206
description: 'A block-indexed FASTQ compression tool in Rust',
176207
themeConfig: {
177208
nav: [
209+
{
210+
text: 'Whitepaper',
211+
link: '/en/whitepaper',
212+
activeMatch: '/en/whitepaper'
213+
},
178214
{
179215
text: 'Guide',
180216
activeMatch: '/en/guide/',
@@ -204,10 +240,12 @@ export default withMermaid(defineConfig({
204240
},
205241
{
206242
text: 'Reference',
207-
activeMatch: '/en/(reference|benchmarks|references|release-notes)',
243+
activeMatch: '/en/(reference|benchmarks|references|release-notes|comparison|theory)',
208244
items: [
209245
{ text: 'Binary Format Spec', link: '/en/reference/format-spec' },
210246
{ text: 'Benchmarks', link: '/en/benchmarks/performance-report' },
247+
{ text: 'Comparison', link: '/en/comparison' },
248+
{ text: 'Theory', link: '/en/theory' },
211249
{ text: 'References', link: '/en/references/' },
212250
{ text: 'Release Notes', link: '/en/release-notes' }
213251
]
@@ -275,6 +313,30 @@ export default withMermaid(defineConfig({
275313
{ text: 'References & Related Work', link: '/en/references/' }
276314
]
277315
}
316+
],
317+
'/en/whitepaper': [
318+
{
319+
text: 'Technical Whitepaper',
320+
items: [
321+
{ text: 'Overview', link: '/en/whitepaper' }
322+
]
323+
}
324+
],
325+
'/en/comparison': [
326+
{
327+
text: 'Comparison',
328+
items: [
329+
{ text: 'Competitive Analysis', link: '/en/comparison' }
330+
]
331+
}
332+
],
333+
'/en/theory': [
334+
{
335+
text: 'Theory',
336+
items: [
337+
{ text: 'Algorithmic Theory', link: '/en/theory' }
338+
]
339+
}
278340
]
279341
}
280342
}
@@ -294,7 +356,7 @@ export default withMermaid(defineConfig({
294356
{ icon: 'github', link: 'https://github.com/LessUp/fq-compressor-rust' }
295357
],
296358
footer: {
297-
message: 'Technical documentation for fqc, a block-indexed FASTQ compression tool.',
359+
message: 'Technical Whitepaper & Architecture Showcase for fqc.',
298360
copyright: 'GPL-3.0 · fqc contributors'
299361
}
300362
},
@@ -312,12 +374,12 @@ export default withMermaid(defineConfig({
312374
dark: 'dark'
313375
},
314376
themeVariables: {
315-
primaryColor: '#0e7c6b',
316-
primaryTextColor: '#1a1f36',
317-
primaryBorderColor: '#0e7c6b',
318-
lineColor: '#4a5568',
319-
secondaryColor: '#f1f5f9',
320-
tertiaryColor: '#ffffff',
377+
primaryColor: '#06b6d4',
378+
primaryTextColor: '#F9FAFB',
379+
primaryBorderColor: '#06b6d4',
380+
lineColor: '#6B7280',
381+
secondaryColor: '#1F2937',
382+
tertiaryColor: '#111827',
321383
fontFamily: 'ui-sans-serif, system-ui, -apple-system, sans-serif',
322384
fontSize: '14px'
323385
}

0 commit comments

Comments
 (0)