First commit for the documentation

doc/.gitignore

@@ -0,0 +1 @@
+book

doc/book.toml

@@ -0,0 +1,5 @@
+[book]
+authors = ["Paul Masurel"]
+multilingual = false
+src = "src"
+title = "Tantivy, the user guide"

doc/src/SUMMARY.md

@@ -0,0 +1,14 @@
+# Summary
+
+
+
+[Avant Propos](./avant-propos.md)
+
+- [Fundamental concepts](./basis.md)
+- [Defining your schema](./schema.md)
+- [Facetting](./facetting.md)
+- [Innerworkings](./innerworkings.md)
+  - [Inverted index](./inverted_index.md)
+
+[Frequently Asked Questions](./faq.md)
+[Examples](./examples.md)

doc/src/avant-propos.md

@@ -0,0 +1,31 @@
+# Foreword, what is the scope of tantivy?
+
+> Tantivy is a **search** engine **library** for Rust.
+
+If you are familiar with Lucene, tantivy is heavily inspired by Lucene's design and
+they both have the same scope and targetted users.
+
+If you are not familiar with Lucene, let's break down our little tagline.
+
+- **Search** here means full-text search : fundamentally, tantivy is here to help you
+identify efficiently what are the documents matching a given query in your corpus.
+But modern search UI are so much more : text processing, facetting, autocomplete, fuzzy search, good
+relevancy, collapsing, highlighting, spatial search.
+
+  While some of these features are not available in tantivy yet, all of these are relevant
+  feature requests. Tantivy's objective is to offer a solid toolbox to create the best search
+  experience. But keep in mind this is just a toolbox.
+  Which bring us to the second keyword...
+
+- **Library** means that you will have to write code. tantivy is not an *all-in-one* server solution.
+  
+  Sometimes a functionality will not be available in tantivy because it is too specific to your use case. By design, tantivy should make it possible to extend
+  the available set of features using the existing rock-solid datastructures. 
+
+   Most frequently this will mean writing your own `Collector`, your own `Scorer` or your own 
+   `Tokenizer/TokenFilter`... But some of your requirement may also be related to 
+   architecture or operations. For instance, you may want to build a large corpus on Hadoop,
+   fine-tune the merge policy to keep your index sharded in a time-wise fashion, or you may want
+   to convert and existing index from a different format.
+   
+   Tantivy exposes its API to do all of these things.

doc/src/basis.md

@@ -0,0 +1 @@
+# Basic concepts

doc/src/examples.md

@@ -0,0 +1 @@
+# Examples

doc/src/facetting.md

@@ -0,0 +1,5 @@
+# Facetting
+
+wewew
+
+## weeewe

doc/src/innerworkings.md

@@ -0,0 +1 @@
+# Innerworkings

doc/src/inverted_index.md

@@ -0,0 +1 @@
+# Inverted index

doc/src/schema.md

@@ -0,0 +1 @@
+# Defining your schema