doc: Add Development section

.github/actions/build/Dockerfile

@@ -1,3 +1,4 @@
 FROM rust:latest
+RUN cargo install mdbook-mermaid
 RUN cargo install mdbook --no-default-features --features search --vers "^0.4" --locked
 CMD ["mdbook", "build", "doc"]

doc/book.toml

@@ -3,4 +3,10 @@ authors = ["Akira Hayakawa"]
 language = "en"
 multilingual = false
 src = "src"
-title = "lolraft documentation"
+title = "lolraft documentation"
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
+[output.html]
+additional-js = ["mermaid.min.js", "mermaid-init.js"]

doc/mermaid-init.js

@@ -0,0 +1 @@
+mermaid.initialize({startOnLoad:true});

doc/src/SUMMARY.md

@@ -2,8 +2,9 @@
 
 - [Multi-Raft](multi-raft.md)
 - [Raft Process](raft-process.md)
-  - [Orbit pattern](orbit-pattern.md)
+  - [Orbit Pattern](orbit-pattern.md)
   - [Application State](application-state.md)
 - [Client Interaction](client-interaction.md)
 - [Cluster Management](cluster-management.md)
-- [Leadership](leadership.md)
+- [Leadership](leadership.md)
+- [Development](development.md)

doc/src/development.md

@@ -0,0 +1,50 @@
+# Development
+
+## Build
+
+(lolraft crate only) The proto file should be compiled manually if you changed the proto file.
+In this case, please run `cargo run -p codegen`.
+
+## Test
+
+For testing, lolraft makes use of docker-compose.
+
+A docker image called testapp is built and the tests create some instances of it for testing: test code is running on dev container and it accesses the docker deamon in the host. In GHA, the tests are run in the same way.
+
+The log output in the stdout/stderr is collected into the log container. This is quite useful for debugging. So here is how you can run the tests for development.
+
+- `docker compose build` to build test application.
+- TERM1: `./log` to start log watcher.
+- TERM2: `./dev` to start the dev container.
+- TERM2: `cargo test`.
+
+```mermaid
+graph
+  subgraph raft_network
+
+  subgraph cluster
+  APP1(testapp-1)
+  APP2(testapp-2)
+  APP3(testapp-3)
+  end
+  
+  DEV(dev)
+  LOG(log)
+  
+  end
+  
+  APP1 -->|log| LOG
+  APP2 -->|log| LOG
+  APP3 -->|log| LOG
+  
+  DEV -->|command| APP1
+  DEV -->|command| APP2
+  DEV -->|command| APP3
+```
+
+## Documentation
+
+You can modify the documentations.
+
+For editing the mdbook under doc/ directory,
+you can run `mdbook serve doc` to start the local mdbook server.