# TiDB Development Guide

This repository contains the source of TiDB Development Guide.

* The target audience of this guide is TiDB contributors, both new and experienced.
* The objective of this guide is to help contributors become an expert of TiDB, who is familiar with its design and implementation and thus is able to use it fluently in the real world as well as develop TiDB itself deeply.

## Requirements

Building the book requires [mdBook](https://github.com/rust-lang-nursery/mdBook). To get it:

```bash
$ cargo install mdbook
```

## Building

To build the book, type:

```bash
$ mdbook build
```

The output will be in the `book` subdirectory. To check it out, open it in your web browser.

*Firefox:*

```bash
$ firefox book/html/index.html                       # Linux
$ open -a "Firefox" book/html/index.html             # OS X
$ Start-Process "firefox.exe" .\book\html\index.html # Windows (PowerShell)
$ start firefox.exe .\book\html\index.html           # Windows (Cmd)
```

*Chrome:*

```bash
$ google-chrome book/html/index.html                 # Linux
$ open -a "Google Chrome" book/html/index.html       # OS X
$ Start-Process "chrome.exe" .\book\html\index.html  # Windows (PowerShell)
$ start chrome.exe .\book\html\index.html            # Windows (Cmd)
```

## Contribute to this guide

See [CONTRIBUTING](/tidb-dev-guide/contributing.md) for details.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zz-jason.gitbook.io/tidb-dev-guide/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.