Skip to content

Commit b9875a6

Browse files
haochengxiahaochengxia
committed
[Doc]: refactor documentations
1 parent 0ea538b commit b9875a6

16 files changed

Lines changed: 105 additions & 13 deletions

‎doc/README.md‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
1+
# libCacheSim documentation
12

2-
## Main tools
3-
* [cachesim](quickstart_cachesim.md)
4-
* [trace utils](quickstart_traceUtils.md)
5-
* [trace analysis](quickstart_traceAnalysis.md)
6-
7-
## Using libCacheSim as a library
8-
* [library](lib.md)
9-
* [add a new algorithm](lib_extend.md)
10-
* [API](lib_api.md)
11-
12-
13-
## Benchmarks
14-
* [benchmarks](quickstart_benchmarks.md)
3+
## Build docs locally
154

5+
```
6+
pip install -r ./requirements.txt
7+
mkdocs serve
8+
```

doc/advanced_lib.md renamed to doc/docs/advanced/advanced_lib.md

File renamed without changes.

doc/advanced_lib_extend.md renamed to doc/docs/advanced/advanced_lib_extend.md

File renamed without changes.

doc/API.md renamed to doc/docs/api/API.md

File renamed without changes.

doc/debug.md renamed to doc/docs/develop/debug.md

File renamed without changes.

doc/install.md renamed to doc/docs/getting-started/install.md

File renamed without changes.

doc/quickstart_cachesim.md renamed to doc/docs/getting-started/quickstart/quickstart_cachesim.md

File renamed without changes.

doc/quickstart_mrcProfiler.md renamed to doc/docs/getting-started/quickstart/quickstart_mrcProfiler.md

File renamed without changes.

doc/quickstart_traceAnalyzer.md renamed to doc/docs/getting-started/quickstart/quickstart_traceAnalyzer.md

File renamed without changes.

doc/quickstart_traceUtils.md renamed to doc/docs/getting-started/quickstart/quickstart_traceUtils.md

File renamed without changes.

0 commit comments

Comments
 (0)