Update READMEs, new placeholders (#2131)

blevesearch · Jan 10, 2025 · bf28642 · bf28642
1 parent 2ef6286
commit bf28642
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/docs/geo.md b/docs/geo.md
@@ -0,0 +1,3 @@
+# Geo spatial search
+
+Redirect to [geo/README.md](https://github.com/blevesearch/bleve/blob/master/geo/README.md)
diff --git a/docs/scoring.md b/docs/scoring.md
@@ -0,0 +1,10 @@
+# Scoring models for document hits
+
+* Default scoring scheme for document hits involving text hits: `tf-idf`.
+* Nearest-neighbor/vector hits scoring depends on chosen `knn distance` metric, highlighted [here](https://github.com/blevesearch/bleve/blob/master/docs/vectors.md#supported).
+* Hybrid search scoring will combine `tf-idf` scores with `knn distance` numbers.
+* *v2.5.0* (and after) will come with support for `bm25` scoring for exact searches.
+
+## BM25
+
+`<wip>`
diff --git a/docs/synonyms.md b/docs/synonyms.md
@@ -1,3 +1,5 @@
 # Synonyms search
 
-* *v2.5.0* (and after) will come with support for **synonyms definitions indexing and search**.
+* *v2.5.0* (and after) will come with support for **synonym definitions indexing and search**.
+
+`<wip>`
diff --git a/geo/README.md b/geo/README.md
@@ -1,4 +1,4 @@
-# geo support in bleve
+# Geo spatial search support in bleve
 
 Latest bleve spatial capabilities are powered by spatial hierarchical tokens generated from s2geometry.
 You can find more details about the [s2geometry basics here](http://s2geometry.io/), and explore the
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Geo spatial search

		Redirect to [geo/README.md](https://github.com/blevesearch/bleve/blob/master/geo/README.md)