docs: add initial documentation (#2)

* tutorial: draft docs

* ci: build tutorial mdbook

* tutorial: 01-01: write docs

* tutorial: update summary

* 01-01: write docs

* 01-01: complete docs

* docs: add build instructions in README

* update summary

* 00: add worldmap

* ci: move rust-toolchain file

Author: wangrunji0408

.github/workflows/ci.yml

@@ -4,13 +4,9 @@ on:
   push:
     branches:
       - main
-    paths:
-      - 'code/**'
   pull_request:
     branches:
       - main
-    paths:
-      - 'code/**'
 
 env:
   CARGO_TERM_COLOR: always
@@ -43,3 +39,16 @@ jobs:
         with:
           command: test
           args: --manifest-path code/Cargo.toml --release --no-fail-fast --all-features
+
+  docs:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+      - name: Install mdbook
+        run: cargo install mdbook mdbook-toc
+      - name: Build docs
+        working-directory: ./docs
+        run: mdbook build

README.md

@@ -3,3 +3,31 @@
 [![CI](https://github.com/singularity-data/risinglight-tutorial/workflows/CI/badge.svg?branch=main)](https://github.com/singularity-data/risinglight-tutorial/actions)
 
 Let's build an OLAP database from scratch!
+
+## Building
+
+The documentation is written in [mdBook][mdBook].
+
+[mdBook]: https://github.com/rust-lang/mdBook
+
+To install mdBook:
+
+```sh
+cargo install mdbook mdbook-toc
+```
+
+Build the documentation:
+
+```sh
+cd docs
+mdbook build
+```
+
+We provide complete codes for each task. 
+
+To build and test these codes:
+
+```sh
+cd code
+cargo test
+```

code/01-01/src/test.rs

@@ -1,3 +1,11 @@
+// Add the following lines to your Cargo.toml file:
+//
+// ```toml
+// [dev-dependencies]
+// sqllogictest = "0.1"
+// test-case = "1.2"
+// ```
+
 use std::path::Path;
 
 use test_case::test_case;

docs/.gitignore

@@ -0,0 +1,2 @@
+book
+.DS_Store

docs/book.toml

@@ -0,0 +1,10 @@
+[book]
+authors = ["Runji Wang"]
+language = "cn"
+multilingual = false
+src = "src"
+title = "RisingLight Tutorial"
+
+[preprocessor.toc]
+command = "mdbook-toc"
+renderer = ["html"]

docs/src/00-lets-build-a-database.md

@@ -0,0 +1,67 @@
+# RisingLight Tutorial
+
+RisingLight 是一个 Rust 语言编写的单机分析型（OLAP）数据库系统。
+
+在这个教程中，我们将会带领大家从零开始，一步一步地实现自己的数据库！
+从一个最简单的 SQL 解析器开始，逐步实现查询引擎、存储引擎、优化器和事务，最终能够运行工业级的 TPC-H 基准测试。
+
+除了标准教科书上的内容以外，你还可以体验到业界最前沿的流式计算引擎 lol。
+
+## 为何要做这个教程
+
+TODO
+
+## RisingLight 世界地图
+
+![](img/worldmap.svg)
+
+<!-- 
+可以画成类似 DDIA 的样子
+ -->
+
+## 如何学习本教程
+
+正如你所见，整个 RisingLight 是一个广阔的开放世界！
+在这里你可以按照自己的兴趣，选择任意一种可行的路径来完成这个数据库的开发。
+当然如果你喜欢按部就班的节奏，我们也提供一条推荐的主线路径供大家参考。
+
+RisingLight 根据数据库中的不同方向，分成了若干小世界。它们整体上相对独立，但相互之间又有千丝万缕的关联。
+每个世界由很多小任务组成，在每个任务中我们会实现一个功能。而每个功能我们都会提供一系列的标准 SQL 语句作为测试，只要通过了全部测试就算完成了这个任务！
+
+例如在第一个任务中，我们提供的测试语句是：
+
+```sql
+SELECT 'Hello, world!'
+```
+
+它的期望输出是：
+
+```
+Hello, world!
+```
+
+只要你的程序对于给定的输入，能够给出正确的输出，我们就认为你正确实现了这一功能。
+
+这种方法叫做 **端到端测试（End-to-End Testing）**。你可以使用任何一种方法来通过测试，并且我们鼓励大家大开脑洞去尝试不同的实现方式。
+
+当然，在没有任何提示的情况下独立完成整个系统的设计与实现是相当困难的，但这也是对能力提高非常有帮助的。
+我们欢迎对自己能力有信心的大佬们来挑战这个 **Hard 模式**，收获更多经验值！
+
+对于其他同学来说，我们会带领大家完成系统的整体设计，提示一些关键的实现细节，并提供必要的框架代码，
+由同学们自行实现剩下的部分。这种是类似其它教程所采用的 **Normal 模式**。
+
+不过更为实际的情况是，在这个教程出来一段时间之后，社区中一定会涌现出大量的优秀作业供大家参考。
+考虑到这点，我们干脆直接公开每个任务的完整代码，官方提供《RisingLight 源码解析》。
+赶时间的朋友就不用亲自下场写代码了，直接来玩适合快速通关的 **Easy 模式** 吧。
+
+以上三种模式，同学们可以根据自己的情况，选择适合自己的方式来完成每个任务。
+需要提醒大家的是，付出和收获往往是成正比的，我们鼓励大家在力所能及的范围内去做更有挑战性的尝试。
+
+为了这种难度的区别，每个任务的文档会分为以下几个部分：
+
+1. 背景知识：介绍完成任务所必须掌握的知识，提供参考资料
+2. 任务目标：描述任务需要完成的内容，需要通过的测试
+3. 整体设计：介绍代码框架和需要注意的细节
+4. 源码解析：详细介绍实现代码
+
+如果你想挑战 Hard，那么看到 2 就可以开始动手了；如果你选择 Normal，那么还可以继续看完 3；而如果你是 Easy 玩家，那就看完全部文档吧！