Merge #1683

1683: add typo tolerance to Meilisearch 101 r=maryamsulemani97 a=maryamsulemani97

closes #1678 

Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>

Author: bors[bot]

.code-samples.meilisearch.yaml

@@ -951,3 +951,10 @@ updating_guide_add_documents_old: |-
     -X POST 'http://localhost:7700/indexes/{index_uid}/documents' \
     -H 'Content-Type: application/json' -d @mydocuments.json \
     -H 'X-Meili-API-Key: API_KEY'
+getting_started_typo_tolerance: |-
+  curl \
+    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "minWordSizeForTypos": { "oneTypo": 4 }
+  }'

.vuepress/public/sample-template.yaml

@@ -145,3 +145,4 @@ updating_guide_get_settings_old: |-
 updating_guide_retrieve_documents_old: |-
 updating_guide_update_settings_old: |-
 updating_guide_add_documents_old: |-
+getting_started_typo_tolerance: |-

learn/getting_started/customizing_relevancy.md

@@ -89,7 +89,7 @@ For example, if you search the `movies` index for `2012`, Meilisearch searches f
 
 <CodeSamples id= "getting_started_update_searchable_attributes" />
 
-Meilisearch will now only consider `title` during search and you will see fewer results.
+Meilisearch will now only consider `title` during search, and you will see fewer results.
 
 ::: note
 
@@ -130,4 +130,23 @@ This will set `winnie` and `piglet` as synonyms; searching for either word will
 
 You can read more about it in our [dedicated guide](/learn/configuration/synonyms.md).
 
-The next chapter tackles more advanced topics including security and data backup.
+## Typo tolerance
+
+Meilisearch is typo tolerant by default. It will help you find relevant search results even if you make spelling mistakes or typos, e.g., searching for `swaj` instead of `swan`.
+
+The `typoTolerance` object allows you to:
+
+- Enable or disable the typo tolerance feature
+- Configure the minimum word size for typos
+- Disable typos on specific words
+- Disable typos on specific attributes
+
+Meilisearch accepts one typo for query terms containing `5` or more characters by default. If you search the movies index for `swaj`, you will not get any results.
+
+<CodeSamples id= "getting_started_typo_tolerance" />
+
+The above code sample sets the minimum word size for one typo to `4` characters. If you search for `swaj` now, you should get some results.
+
+You can read more about typo tolerance in our [dedicated guide](/learn/configuration/typo_tolerance.md).
+
+The next chapter tackles more advanced topics, including security and data backup.