Skip to content

Commit e85e3d0

Browse files
committed
Update Jekyll deployment workflow and add documentation for benchmarks
- Changed the Jekyll source directory from `./` to `./docs` for proper site generation. - Introduced a new `benchmarks.md` file to document benchmark reports and release summaries. - Created an `index.md` file for the CacheKit documentation site, linking to key resources and guides.
1 parent 0f797a4 commit e85e3d0

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

.github/workflows/jekyll-gh-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
- name: Build with Jekyll
3434
uses: actions/jekyll-build-pages@v1
3535
with:
36-
source: ./
36+
source: ./docs
3737
destination: ./_site
3838
- name: Upload artifact
3939
uses: actions/upload-pages-artifact@v4

docs/benchmarks.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Benchmarks
2+
3+
This page links to the latest benchmark reports and the release-tag snapshots.
4+
5+
- [Latest benchmarks](../benchmarks/latest/)
6+
- [Release benchmarks (by tag)](../benchmarks/)
7+
8+
For local runs and raw numbers, see `benches/README.md`.
9+
10+
## Release summary
11+
12+
| Release | Date | Environment | Micro-ops (ns/op) | Policy throughput (Melem/s) | Workload throughput (Melem/s) | Report link |
13+
| --- | --- | --- | --- | --- | --- | --- |
14+
| v0.1.0 | 2025-01-12 | TBD | TBD | TBD | TBD | TBD |

docs/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# CacheKit Docs
2+
3+
Welcome to the CacheKit documentation site.
4+
5+
## Getting started
6+
7+
- [Design overview](design.md)
8+
- [Policy overview](policies/README.md)
9+
- [Policy roadmap](policies/roadmap/README.md)
10+
- [Policy data structures](policy-ds/README.md)
11+
- [Policy survey and tradeoffs](policies.md)
12+
- [Benchmarks](benchmarks.md)
13+
14+
## Release and maintenance
15+
16+
- [Release checklist](release-checklist.md)
17+
- [Documentation style guide](style-guide.md)
18+
19+
## Misc
20+
21+
- [Integration notes](integration.md)
22+
- [Metrics notes](metrics.md)

0 commit comments

Comments
 (0)