fix: doc

akiradeveloper · Jun 9, 2024 · 7b98ec0 · 7b98ec0
1 parent f2ac53b
commit 7b98ec0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/doc/src/development.md b/doc/src/development.md
@@ -2,10 +2,10 @@
 
 ## Build
 
-(lolraft crate only) The proto file should be compiled manually if you changed the proto file.
+The proto file should be compiled manually if you changed the proto file.
 In this case, please run `cargo run -p codegen`.
 
-## Test
+## Testing
 
 For testing, lolraft makes use of docker-compose.
 
@@ -42,6 +42,14 @@ graph
   DEV -->|command| APP3
 ```
 
+## Benchmark
+
+You can run benchmark in a similar way as testing.
+
+- `docker compose build` to build test application.
+- TERM1: `./dev`
+- TERM1: `cargo +nightly bench`.
+
 ## Documentation
 
 You can modify the documentations.

diff --git a/doc/src/multi-threading.md b/doc/src/multi-threading.md
@@ -1,4 +1,4 @@
-# Orbit Pattern
+# Multi Threading
 
 Inside RaftProcess, there is a state called `RaftCore` and
 many threads to process it concurrently on an event-driven basis,