add search docs (#87)

papermerge · Jan 18, 2024 · d4c3594 · d4c3594
1 parent 9369403
commit d4c3594
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/docs/user/search.md b/docs/user/search.md
@@ -0,0 +1,29 @@
+# Search
+
+{{extra.project}} offers an extensive searching mechanism that is designed to allow you to quickly find a document you're looking for.
+
+When you search {{extra.project}} for a document, it tries to match this query
+against your documents. {{extra.project}} will look for matching documents by
+inspecting their content, title, and tags.
+
+!!! note
+
+	{{extra.project}} searches only in **content of the last version** of the document
+
+
+By default, {{extra.project}} returns only documents which contain all words typed in
+the search bar. However, {{extra.project}} also offers addional search syntax if you
+want to drill down the results further.
+
+
+Matching inexact words:
+
+	*5951
+
+Will return document with title: brother_005951.pdf
+
+Matching specific tags:
+
+	tags:paid
+
+will return documents with tag "paid"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,6 +14,7 @@ nav:
     - user/user-interface.md
     - user/upload-documents.md
     - user/tags.md
+    - user/search.md
     - user/page-management.md
     - user/versions.md
     - user/merge-documents.md