TiKV Explained

Mental models for understanding TiKV from the ground up.

This repository contains the source for the book TiKV Explained: Mental Models from the Ground Up. It is built with mdBook.

Read the book at hbisheng.github.io/tikv-explained.

The book is a work in progress. Corrections and suggestions are welcome through GitHub Issues.

Related Links

• Official TiKV website
• TiKV source code

Local Workflow

Build the static book:

mdbook build

Preview while writing:

mdbook serve --open

The source lives in src/. The generated static site is written to book/ and is intentionally ignored by Git.

License

Unless stated otherwise:

• Prose and diagrams are licensed under CC BY 4.0.
• Code snippets and pseudocode are licensed under Apache-2.0.

See LICENSE.md for details.