History

Jian Zhang 400aa67373 [to #348 ] add introduction for the whole document (#428 )		2021-12-22 21:34:42 +08:00
..
src	[to #348 ] add introduction for the whole document (#428 )	2021-12-22 21:34:42 +08:00
README.md	[to #348 ] use mdbook and github action to maintain documents (#407 )	2021-12-15 15:40:17 +08:00
book.toml	[to #348 ] use mdbook and github action to maintain documents (#407 )	2021-12-15 15:40:17 +08:00

README.md

Client Java Docs

NOTE: See tikv.github.io/client-java for the rendered developer and contributor documents.

This directory contains all the source of developer and contributor documentations in markdown format. The table of content can be found in ./src/SUMMARY.md.

How to contribute to the document

The rendered document is generated by mdbook, to get it:

cargo install mdbook

Build the source in your development machine:

mdbook build

Get more information about how to use mdbook:

mdbook help