Skip to content

Commit 6e2dfb2

Browse files
author
shijiashuai
committed
docs: add front matter and SEO files for GitHub Pages
- Add front matter to all documentation files for Jekyll processing - Add sitemap.xml and robots.txt for SEO optimization - Update changelog files with proper layout configuration
1 parent 7e46999 commit 6e2dfb2

18 files changed

Lines changed: 139 additions & 14 deletions

‎CHANGELOG.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: page
3+
title: Changelog
4+
description: All notable changes to LLM-Speed project
5+
lang: en
6+
---
7+
18
# Changelog
29

310
All notable changes to this project will be documented in this file.
@@ -10,23 +17,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1017
## [Unreleased]
1118

1219
### Added
13-
- Complete SDD (Spec-Driven Development) documentation structure
14-
- README.md files for all `/specs` subdirectories (product/, rfc/, api/, db/, testing/)
15-
- Professional AGENTS.md with AI workflow instructions
16-
- Updated CONTRIBUTING.md with SDD workflow guidelines
20+
- GitHub Pages optimization with front matter for all documentation files
21+
- Sitemap.xml and robots.txt for better SEO
22+
- Bilingual navigation support (English/Chinese)
23+
- Jekyll layout optimization for documentation pages
1724

1825
### Changed
19-
- Restructured `/specs` directory with proper README files for each subdirectory
20-
- Updated README.md with English primary and Chinese link
21-
- Cleaned up project structure, removed `.qwen` directory
22-
- Unified documentation organization following GitHub best practices
23-
24-
### Removed
25-
- `.qwen` directory (AI tool configuration, no longer needed)
26+
- Optimized `_config.yml` navigation structure with language-specific menus
27+
- Improved documentation sidebar with proper language sections
2628

2729
---
2830

29-
## [0.3.0] - 2026-04-16
31+
## [0.3.0] - 2026-04-22
3032

3133
### Added
3234
- **Bilingual Documentation**: Complete Chinese and English documentation support

‎_layouts/docs.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
22
layout: default
33
---
4-
{{ content }}
4+
5+
<article class="docs-content">
6+
{{ content }}
7+
</article>

‎_layouts/page.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
22
layout: default
33
---
4-
{{ content }}
4+
5+
<div class="page-content-full">
6+
{{ content }}
7+
</div>

‎docs/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Documentation
4+
description: Complete documentation for CUDA LLM Kernel Optimization library
5+
lang: en
6+
---
7+
18
# CUDA LLM Kernel Optimization Documentation
29

310
Welcome to the documentation for CUDA LLM Kernel Optimization — a high-performance CUDA kernel library for LLM inference.

‎docs/changelog/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: docs
3+
title: Changelog
4+
description: All notable changes to LLM-Speed project
5+
lang: en
6+
---
7+
18
# Changelog
29

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

‎docs/changelog/CHANGELOG.zh-CN.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: docs
3+
title: 变更日志
4+
description: LLM-Speed 项目所有重要的变更记录
5+
lang: zh-CN
6+
---
7+
18
# 变更日志
29

310
本项目所有重要的变更都将记录在此文件中。

‎docs/changelog/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: docs
3+
title: Changelog
4+
description: Project change history and version tracking
5+
lang: en
6+
---
7+
18
# Changelog Directory / 变更日志目录
29

310
Project change history and version tracking. / 项目变更历史和版本追踪。

‎index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: default
33
title: LLM-Speed
44
description: High-performance CUDA kernel library for LLM inference — FlashAttention with O(N) memory, Tensor Core GEMM acceleration, and seamless PyTorch integration
5+
lang: en
56
---
67

78
<!-- Hero Section -->

‎robots.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
User-agent: *
2+
Allow: /
3+
4+
Sitemap: https://lessup.github.io/llm-speed/sitemap.xml

‎sitemap.xml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
---
3+
<?xml version="1.0" encoding="UTF-8"?>
4+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
5+
<url>
6+
<loc>{{ site.url }}{{ site.baseurl }}/</loc>
7+
<changefreq>weekly</changefreq>
8+
<priority>1.0</priority>
9+
</url>
10+
{% for page in site.pages %}
11+
{% if page.layout and page.title %}
12+
<url>
13+
<loc>{{ site.url }}{{ site.baseurl }}{{ page.url | remove: 'index.html' }}</loc>
14+
<changefreq>weekly</changefreq>
15+
<priority>0.8</priority>
16+
</url>
17+
{% endif %}
18+
{% endfor %}
19+
{% for doc in site.docs %}
20+
{% if doc.layout %}
21+
<url>
22+
<loc>{{ site.url }}{{ site.baseurl }}{{ doc.url | remove: 'index.html' }}</loc>
23+
<changefreq>weekly</changefreq>
24+
<priority>0.7</priority>
25+
</url>
26+
{% endif %}
27+
{% endfor %}
28+
</urlset>

0 commit comments

Comments
 (0)