DOCS: Add site search optimization (#58)

jdillard · Jan 28, 2023 · f6c998c · f6c998c
1 parent 8eff853
commit f6c998c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -14,6 +14,8 @@ Changelog
   `#55 <https://github.com/jdillard/sphinx-sitemap/pull/55>`_
 * |:sparkles:| NEW: Add support for Sphinx config "html_file_suffix"
   `#57 <https://github.com/jdillard/sphinx-sitemap/pull/57>`_
+* |:books:| DOCS: Add site search optimization
+  `#58 <https://github.com/jdillard/sphinx-sitemap/pull/58>`_
 
 2.4.0
 -----

diff --git a/docs/_vale/ignore_words.txt b/docs/_vale/ignore_words.txt
@@ -1 +1,2 @@
 Conda
+Algolia
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ documentation.
 
    getting-started
    advanced-configuration
-   search-engine-optimization
+   search-optimization
    configuration-values
    contributing
    changelog

diff --git a/docs/search-engine-optimization.rst → docs/search-optimization.rst b/docs/search-engine-optimization.rst → docs/search-optimization.rst
@@ -1,8 +1,11 @@
 Getting the Most out of the Sitemap
 ===================================
 
+Search Engine Optimization
+--------------------------
+
 Using robots.txt
-----------------
+^^^^^^^^^^^^^^^^
 
 Add a **robots.txt** file in the **source** directory which contains a link to the **sitemap.xml** or **sitemapindex.xml** file. For example::
 
@@ -17,6 +20,17 @@ Then, add **robots.txt** to :confval:`html_extra_path` in **conf.py**:
   html_extra_path = ['robots.txt']
 
 Submit Sitemap to Search Engines
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Submit the **sitemap.xml** or **sitemapindex.xml** to the appropriate search engine tools.
+
+Site Search Optimization
+------------------------
+
+Site search crawlers can also take advantage of sitemaps as starting points for crawling.
+
+Examples:
+
+- `Algolia`_
+
+.. _Algolia: https://www.algolia.com/doc/tools/crawler/apis/configuration/sitemaps/