Skip to content

Commit

Permalink
docs: refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
xieby1 committed Dec 24, 2024
1 parent 6b6ec88 commit bffd4f6
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 623 deletions.
2 changes: 1 addition & 1 deletion docs/designs/1.overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 🌏概览(Overview)
# 概览(Overview)


2 changes: 1 addition & 1 deletion docs/designs/2.configuration_system.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 🧾配置系统(Configuration System)
# 配置系统(Configuration System)

TODO:
2 changes: 1 addition & 1 deletion docs/designs/3.benchmarks/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 📈基准测试(Benchmarks)
# 基准测试(Benchmarks)

TODO:
2 changes: 1 addition & 1 deletion docs/designs/4.builders/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🔨构建框架(Builders)
# 构建框架(Builders)

![](./images/overview_py.svg)

Expand Down
10 changes: 5 additions & 5 deletions docs/generate_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ def generate_section_body(root_dir:str, sub_dir:str) -> list[str]:

print("# Summary")
print("")
print("# 入门(Get Started)")
print("# 🏠入门(Get Started)")
print("")
print("* [🏠README.md](./index.md)")
print("* [README.md](./index.md)")
print("")
print("# 使用(Usages)")
print("# 📝使用(Usages)")
print("")
for line in generate_section_body(sys.argv[1], "usages/"):
print(line)
print("")
print("# 设计(Designs)")
print("# 🖊️设计(Designs)")
print("")
for line in generate_section_body(sys.argv[1], "designs/"):
print(line)
print("")
print("# 参考(References)")
print("# 🗂️参考(References)")
print("")
for line in generate_section_body(sys.argv[1], "references/"):
print(line)
2 changes: 1 addition & 1 deletion docs/references/1.configurable.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 🧾可配参数(Configurable Arguments)
# 可配参数(Configurable Arguments)

{{ #include ./default_extract.mkd }}
2 changes: 1 addition & 1 deletion docs/references/2.benchmarks_scope.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# 📈基准测试围(Benchmarks Scope)
# 基准测试围(Benchmarks Scope)
2 changes: 1 addition & 1 deletion docs/references/3.builders_scope.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# 🔨构建器围(Builders Scope)
# 构建器围(Builders Scope)
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 📊输出(Outputs
# 构建状态(Build Status

下面的表格展示了Deterload的构建结果,具体说明如下:
下面的表格展示构建出工作负载的状态,具体说明如下:

* `Date`行表示构建开始的时间,格式为年月日时分秒(yymmddhhmmss)。
各列按照`Date`降序排列(最新排最前面)。
Expand All @@ -10,7 +10,7 @@
每个单元格都用颜色标记,不同的颜色表示不同的哈希值。
通过这种颜色标记,可以轻松看出多次构建之间是否保持了**确定性**

The tables below demonstrate the build results of Deterload, with the following details:
The tables below demonstrate the status of built workloads, with the following details:

* The `Date` row indicates the build start time in yymmddhhmmss format.
Columns are sorted by `Date` in descending order (most recent first).
Expand Down
4 changes: 3 additions & 1 deletion docs/usages/1.building_outputs.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# 🔨构建各类输出(Building Various Outputs)
# 构建工作负载(Building Workloads)


2 changes: 1 addition & 1 deletion docs/usages/2.configuring.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🧾配参数(Configuring Arguments)
# 配参数(Configuring Arguments)

Deterload支持多种配置方式:

Expand Down
2 changes: 1 addition & 1 deletion docs/usages/3.examples.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# 🎮例子(Examples)
# 例子(Examples)
2 changes: 1 addition & 1 deletion docs/usages/4.running/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 💽运行输出的镜像(Running Output Images
# 运行输出的工作负载(Running Output Workloads

TODO:
604 changes: 0 additions & 604 deletions theme/highlight.js

This file was deleted.

0 comments on commit bffd4f6

Please sign in to comment.