aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/reference_manual/index.md
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
committerAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
commit5b659b28ce6bef15072d2fc93f777aa8ff73b2d8 (patch)
treee7ec9ec9dae459aeb6a99b35c537d46745053ec0 /doc/book/src/reference_manual/index.md
parent6a3dcf39740cda27e61b93582b6fea66991ec4f2 (diff)
parentea21c544343afeb37e96678089bcd535e64982a7 (diff)
downloadgarage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.tar.gz
garage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.zip
Merge pull request 'Add a `mdbook` documentation to present garage and help user on-boarding' (#45) from feature/mdbook into master
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/45
Diffstat (limited to 'doc/book/src/reference_manual/index.md')
-rw-r--r--doc/book/src/reference_manual/index.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/book/src/reference_manual/index.md b/doc/book/src/reference_manual/index.md
new file mode 100644
index 00000000..0d4bd6f3
--- /dev/null
+++ b/doc/book/src/reference_manual/index.md
@@ -0,0 +1,5 @@
+# Reference Manual
+
+A reference manual contains some extensive descriptions about the features and the behaviour of the software.
+Reading of this chapter is recommended once you have a good knowledge/understanding of Garage.
+It will be useful if you want to tune it or to use it in some exotic conditions.