docs: update some expressions

Author: BobAnkh

.github/workflows/gh-pages.yml

@@ -0,0 +1,34 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'guide/**'
+      - '.github/workflows/gh-pages.yml'
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: '0.4.40'
+          # mdbook-version: 'latest'
+
+      - run: mdbook build
+        working-directory: ./guide
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./guide/book

README.md

@@ -4,10 +4,12 @@
   </h1>
   <a href="https://github.com/stack-rs/rattan/releases"><img alt="GitHub Release" src="https://img.shields.io/github/release/stack-rs/rattan.svg"></a>
   <a href="https://crates.io/crates/rattan"><img alt="crates.io" src="https://img.shields.io/crates/v/rattan.svg"></a>
-  <a href="https://github.com/stack-rs/rattan/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/stack-rs/rattan/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://github.com/stack-rs/rattan/actions/workflows/build.yml"><img alt="CI" src="https://github.com/stack-rs/rattan/actions/workflows/build.yml/badge.svg"></a>
 </div>
 
-**Rattan** is a high-performance modular transport channel emulator ready for modern WAN. We provide a simple and easy-to-use API to create and manage network emulations. Rattan is designed to be used in a wide range of scenarios, from testing network applications to debugging complex network performance issues.
+**Rattan** is a fast and extensible Internet path emulator framework.
+
+We provide a simple and easy-to-use API to create and manage network emulations. Rattan is designed to be used in a wide range of scenarios, from testing network applications to debugging complex network performance issues.
 
 Our modular design makes it easy to extend **Rattan** with different network effects. We provide a set of built-in modules that can be used to emulate different network conditions, such as bandwidth, latency, packet loss, ISP policies and etc.
 
@@ -19,6 +21,13 @@ We provide users with a CLI tool to use our pre-defined channels or cells and al
 
 Please check our [User Guide](https://docs.stack.rs/rattan) for how to use **Rattan**.
 
+## Design Targets
+
+- **High Performance**. Rattan provides both high peak performance and execution efficiency.
+- **Flexible**. Rattan tries to be agnostic of the underlying path emulation model.
+- **Extensible**. Rattan provides rich features out-of-the-box, meanwhile tends to be easily extensible for custom conditions.
+- **User-Friendly**. Rattan aims to provide a simple and intuitive interface for quick usage on common cases and ensure complete controllability under the hood to cover the corner as well.
+
 ## Contributing
 
 Rattan is free and open source. You can find the source code on

guide/src/README.md

@@ -4,23 +4,25 @@
   </h1>
   <a href="https://github.com/stack-rs/rattan/releases"><img alt="GitHub Release" src="https://img.shields.io/github/release/stack-rs/rattan.svg"></a>
   <a href="https://crates.io/crates/rattan"><img alt="crates.io" src="https://img.shields.io/crates/v/rattan.svg"></a>
-  <a href="https://github.com/stack-rs/rattan/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/stack-rs/rattan/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://github.com/stack-rs/rattan/actions/workflows/build.yml"><img alt="CI" src="https://github.com/stack-rs/rattan/actions/workflows/build.yml/badge.svg"></a>
 </div>
 
 # Introduction
 
-**Rattan** is a high-performance modular transport channel emulator ready for modern WAN. We provide a simple and easy-to-use API to create and manage network emulations. Rattan is designed to be used in a wide range of scenarios, from testing network applications to debugging complex network performance issues.
+**Rattan** is a fast and extensible Internet path emulator framework.
 
-Our modular design makes it easy to extend **Rattan** with different network effects. We provide a set of built-in modules that can be used to emulate different network conditions, such as bandwidth, latency, packet loss, ISP policies and etc.
+We provide a simple and easy-to-use API to create and manage network emulations. Rattan is designed to be used in a wide range of scenarios, from testing network applications to debugging complex network performance issues.
+
+Our modular design makes it easy to extend **Rattan** with different network effects or conditions. We provide a set of built-in modules that can be used to emulate different network conditions, such as bandwidth, latency, packet loss, ISP policies and etc.
 
 We support Linux only at the moment. Currently, kernel version v5.4, v5.15, v6.8 and v6.10 are tested.
 
 ## Design Targets
 
-- **Flexible**. Rattan is agnostic of path emulation model.
-- **Fast**. Rattan provides both high peak performance and execution efficiency.
-- **Extensible**. Rattan provides rich features out-of-the-box but easily extensible for custom conditions.
-- **User-Friendly**. Rattan provides simple and intuitive interfaces for quick usage but also ensure it's fully controllable under the hood.
+- **High Performance**. Rattan provides both high peak performance and execution efficiency.
+- **Flexible**. Rattan tries to be agnostic of the underlying path emulation model.
+- **Extensible**. Rattan provides rich features out-of-the-box, meanwhile tends to be easily extensible for custom conditions.
+- **User-Friendly**. Rattan aims to provide a simple and intuitive interface for quick usage on common cases and ensure complete controllability under the hood to cover the corner as well.
 
 ## Basic Concepts
 

guide/src/guide/cli.md

@@ -11,7 +11,7 @@ We include a set of predefined cells and templated channels in the tool to help
 You can emulate a simple network path with just a few commands.
 - [rattan run](flexible-configuration.md):
 Run the instance according to the configuration.
-For more complex configurations or reproduction purpose, you can use the flexible configuration file to define your own cells, channels and even routes.
+For more complex configurations or reproduction purpose, you can use the flexible configuration file to define your own channel with specific cells, network paths and even routes.
 
 There are also global options that you can use to customize the behavior of the tool:
 

guide/src/guide/predefined-channels.md

@@ -4,6 +4,7 @@ The templated channels consist of a set of cells defined in the `rattan-core` li
 You can use these channels through the `rattan link` subcommand with just a few command line arguments.
 
 For now, we only provide a simple bidirectional channel, with each direction comprising three cells: `bandwidth`, `delay` and `loss`.
+This channel is suitable for most common network emulation scenarios.
 
 You can configure the parameters of each cell by passing the arguments to the subcommand.