Shazwazza · nzdev · Jan 16, 2023 · Jan 16, 2023 · Jan 17, 2023 · Jan 17, 2023
diff --git a/.github/workflows/docfx-gh-pages.yml b/.github/workflows/docfx-gh-pages.yml
@@ -33,7 +33,7 @@ jobs:
       - name: Setup Github Pages
         uses: actions/configure-pages@v3        
       - name: Build DocFX Site
-        uses: VakuWare/docfx-pdf-action@v1.4.0
+        uses: nunit/docfx-action@v2.10.0
         with:
          args: docs/docfx.json
       - name: Upload docfx built site artifact

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -1,7 +1,7 @@
 ---
 uid: apidocsindex
 ---
-# Examine V3 API Documentation
+# Examine V4 API Documentation
 
 API documentation is automatically generated.
 

diff --git a/docs/articles/configuration.md b/docs/articles/configuration.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Configuration
 permalink: /configuration
 uid: configuration

diff --git a/docs/articles/indexing.md b/docs/articles/indexing.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Indexing
 permalink: /indexing
 uid: indexing

diff --git a/docs/articles/searching.md b/docs/articles/searching.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Searching
 permalink: /searching
 uid: searching

diff --git a/docs/articles/sorting.md b/docs/articles/sorting.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Sorting
 permalink: /sorting
 uid: sorting

diff --git a/docs/articles/suggesting.md b/docs/articles/suggesting.md
@@ -0,0 +1,87 @@
+---
+layout: page
+title: Suggesting
+permalink: /suggesting
+ref: suggesting
+order: 2
+---
+Suggesting and Spell Checking
+===
+
+_**Tip**: There are many examples of searching in the [`SuggesterApiTests` source code](https://github.com/Shazwazza/Examine/blob/master/src/Examine.Test/Lucene/Suggest/SuggesterApiTests.cs) to use as examples/reference._
+
+
+## Registering Suggesters
+
+On the index to register the Suggesters, create a SuggesterDefinitionCollection and set it on IndexOptions.SuggesterDefinitions
+
+Examples for suggesting or spellchecking based on the "fullName" index field.
+
+```cs
+ var suggesters = new SuggesterDefinitionCollection();
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.AnalyzingInfixSuggester, ExamineLuceneSuggesterNames.AnalyzingInfixSuggester, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.AnalyzingSuggester, ExamineLuceneSuggesterNames.AnalyzingSuggester, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker, ExamineLuceneSuggesterNames.DirectSpellChecker, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_LevensteinDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_LevensteinDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_JaroWinklerDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_JaroWinklerDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_NGramDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_NGramDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.FuzzySuggester, ExamineLuceneSuggesterNames.FuzzySuggester, new string[] { "fullName" }));
+```
+
+## Suggester API
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new SuggestionOptions(5,ExamineLuceneSuggesterNames.AnalyzingSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions.
+
+## Lucene Suggesters
+
+To generate suggestions for input text, retreive the ISuggester from the index IIndex.Suggester.
+
+### Analyzing Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.AnalyzingInfixSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions, and will highlight the result text which matches the input text..
+
+### Analyzing Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.AnalyzingSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions.
+
+### Fuzzy Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.FuzzySuggester));
+```
+
+This code will run a Fuzzy suggestion for the input text "Sam", returning up to 5 suggestions.
+
+## Lucene Spellcheckers
+
+To generate spellchecker suggestions for input text, retreive the ISuggester from the index IIndex.Suggester.
+
+### Direct SpellChecker Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.DirectSpellChecker));
+```
+
+This code will run a spellchecker suggestion for the input text "Sam" returning up to 5 suggestions.
diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml
@@ -7,4 +7,8 @@
 - name: Sorting
   href: sorting.md
 - name: Paging
-  href: sorting.md#paging-and-limiting-results
+  href: sorting.md#paging-and-limiting-results
+- name: Suggesters
+  href: suggesting.md
+- name: Spellchecking
+  href: suggesting.md#lucene-spellcheckers
diff --git a/docs/developerguides/buildtest.md b/docs/developerguides/buildtest.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: Build and Test
 permalink: /devbuildtest
 uid: devbuildtest

diff --git a/docs/developerguides/codestructure.md b/docs/developerguides/codestructure.md
@@ -1,9 +1,8 @@
 ---
-layout: page
 title: Code Structure
 permalink: /devcodestructure
 uid: devcodestructure
-order: 1
+order: 2
 ---
 
 Code Structure

diff --git a/docs/developerguides/docsite.md b/docs/developerguides/docsite.md
@@ -1,9 +1,8 @@
 ---
-layout: page
 title: Documentation Site
 permalink: /devdocsite
 uid: devdocsite
-order: 1
+order: 3
 ---
 
 Documentation Site
@@ -16,7 +15,7 @@ The easiest way to get started is to edit an existing page by clicking the Impro
 
 ## Building documentation
 
-1. Download [docfx](https://github.com/dotnet/docfx/releases).
+1. Install [docfx](https://github.com/dotnet/docfx/releases) dotnet tool update -g docfx.
 2. Unzip the release and add the folder to your system path variables.
 3. Open a terminal, for example PowerShell or the VS Code terminal.
 4. Change directory to /docs

diff --git a/docs/developerguides/roadmap.md b/docs/developerguides/roadmap.md
@@ -1,9 +1,8 @@
 ---
-layout: page
 title: Roadmap
 permalink: /devroadmap
 uid: devroadmap
-order: 1
+order: 4
 ---
 
 Examine.Lucene Roadmap
@@ -13,21 +12,27 @@ This page covers the roadmap for the core Examine abstractions and the Examine.L
 
 ## Ongoing and future work
 
-- [ ] [Facet Deep Paging](https://github.com/Shazwazza/Examine/pull/321)
-- [ ] [Hierarchical Faceting API (Taxonomy)](https://github.com/Shazwazza/Examine/pull/323)
 - [ ] [Suggestions API and Spellchecking API](https://github.com/Shazwazza/Examine/pull/326)
 - [ ] [Similarity API (BM25)](https://github.com/Shazwazza/Examine/pull/327)
 - [ ] [GeoSpatial API](https://github.com/Shazwazza/Examine/pull/328)
 - [ ] [Custom Scoring API](https://github.com/Shazwazza/Examine/pull/338)
 
 ## Past and completed work
 
+- [x] [Facet Deep Paging](https://github.com/Shazwazza/Examine/pull/321)
+- [x] [Hierarchical Faceting API (Taxonomy)](https://github.com/Shazwazza/Examine/pull/323)
 - [x] [Nullable Support](https://github.com/Shazwazza/Examine/pull/313)
 - [x] [Faceting API (SortedDocValues)](https://github.com/Shazwazza/Examine/pull/311)
 - [x] [Docfx website](https://github.com/Shazwazza/Examine/pull/322)
 - [x] [Deep Paging](https://github.com/Shazwazza/Examine/pull/320)
 
 ## Release Notes
 
-### Examine 3.1
-[Examine 3.1 Release Notes](https://github.com/Shazwazza/Examine/releases/tag/v3.1.0)
+### Examine 4.0.0 beta 1
+[Examine 4.0.0 beta 1 Release Notes](https://github.com/Shazwazza/Examine/releases/tag/v4.0.0-beta.1)
+
+### Examine v3.2.0 beta 9
+[Examine v3.2.0 beta 9 Release Notes](https://github.com/Shazwazza/Examine/releases/tag/v3.2.0-beta.9)
+
+### Examine 3.1.0
+[Examine 3.1.0 Release Notes](https://github.com/Shazwazza/Examine/releases/tag/v3.1.0)
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -66,8 +66,14 @@
     "fileMetadataFiles": [],
     "template": [
       "default",
-      "templates/material"
+      "modern",
+      "templates/examinemodern"
     ],
+    "sitemap": {
+      "baseUrl": "https://shazwazza.github.io/Examine",
+      "priority": 0.1,
+      "changefreq": "monthly"
+    },
     "postProcessors": ["ExtractSearchIndex"],
     "markdownEngineName": "markdig",
     "noLangKeyword": false,
@@ -76,6 +82,7 @@
     "disableGitFeatures": false,
     "globalMetadata": {
       "_appTitle": "Examine",
+      "_appName": "Examine",
       "_appFooter": "Examine",
       "_enableSearch": true,
       "_gitContribute": {
@@ -85,6 +92,8 @@
       },
       "_appLogoPath": "images/headerlogo.png",
       "_appFaviconPath": "images/favicon.ico"
+    },
+    "fileMetadata": {
     }
   }
 }
diff --git a/docs/docs-v1-v2/configuration.md b/docs/docs-v1-v2/configuration.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: V1/V2 Configuration
 permalink: /configuration
 uid: v2configuration

diff --git a/docs/docs-v1-v2/indexing.md b/docs/docs-v1-v2/indexing.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: V1/V2 Indexing
 permalink: /indexing
 uid: v2indexing

diff --git a/docs/docs-v1-v2/searching.md b/docs/docs-v1-v2/searching.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: V1/V2 Searching
 permalink: /searching
 uid: v2searching

diff --git a/docs/docs-v1-v2/sorting.md b/docs/docs-v1-v2/sorting.md
@@ -1,5 +1,4 @@
 ---
-layout: page
 title: V1/V2 Sorting
 permalink: /sorting
 uid: v2sorting

diff --git a/docs/index.md b/docs/index.md
@@ -36,6 +36,7 @@ Releases are available [here](https://github.com/Shazwazza/Examine/releases) and
 
 | Examine Version | .NET |
 | --------------- | ---- |
+| V4 | .NET Standard 2.0 |
 | V3 | .NET Standard 2.0 |
 | V2 | .NET Standard 2.0 |
 | V1 | .NET Framework 4.5.2 |
@@ -47,7 +48,7 @@ Releases are available [here](https://github.com/Shazwazza/Examine/releases) and
 1. Install
 
     ```powershell
-    > dotnet add package Examine --version 3.0.1
+    > dotnet add package Examine --version 4.0.0-beta1
     ```
 
 1. Configure Services and create an index

diff --git a/docs/suggesting.md b/docs/suggesting.md
@@ -0,0 +1,83 @@
+---
+layout: page
+title: Suggesting
+permalink: /suggesting
+ref: suggesting
+order: 2
+---
+Suggesting and Spell Checking
+===
+
+_**Tip**: There are many examples of searching in the [`SuggesterApiTests` source code](https://github.com/Shazwazza/Examine/blob/master/src/Examine.Test/Lucene/Suggest/SuggesterApiTests.cs) to use as examples/reference._
+
+
+## Registering Suggesters
+
+On the index to register the Suggesters, create a SuggesterDefinitionCollection and set it on IndexOptions.SuggesterDefinitions
+
+Example
+
+```cs
+ var suggesters = new SuggesterDefinitionCollection();
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.AnalyzingInfixSuggester, ExamineLuceneSuggesterNames.AnalyzingInfixSuggester, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.AnalyzingSuggester, ExamineLuceneSuggesterNames.AnalyzingSuggester, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker, ExamineLuceneSuggesterNames.DirectSpellChecker, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_LevensteinDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_LevensteinDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_JaroWinklerDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_JaroWinklerDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.DirectSpellChecker_NGramDistance, ExamineLuceneSuggesterNames.DirectSpellChecker_NGramDistance, new string[] { "fullName" }));
+            suggesters.AddOrUpdate(new SuggesterDefinition(ExamineLuceneSuggesterNames.FuzzySuggester, ExamineLuceneSuggesterNames.FuzzySuggester, new string[] { "fullName" }));
+```
+
+## Suggester API
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new SuggestionOptions(5,ExamineLuceneSuggesterNames.AnalyzingSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions.
+
+## Lucene Suggesters
+
+To generate suggestions for input text, retreive the ISuggester from the index IIndex.Suggester.
+
+### Analyzing Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.AnalyzingInfixSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions, and will highlight the result text which matches the input text..
+
+### Analyzing Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.AnalyzingSuggester));
+```
+
+This code will run a suggestion for the input text "Sam", returning up to 5 suggestions.
+
+### Fuzzy Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.FuzzySuggester));
+```
+
+This code will run a Fuzzy suggestion for the input text "Sam", returning up to 5 suggestions.
+
+### Direct SpellChecker Suggester
+
+```cs
+var suggester = index.Suggester;
+var query = suggester.CreateSuggestionQuery();
+var results = query.Execute("Sam", new LuceneSuggestionOptions(5, ExamineLuceneSuggesterNames.DirectSpellChecker));
+```
+
+This code will run a spellchecker suggestion for the input text "Sam" returning up to 5 suggestions.