NGSTACK-843: reformat docs and update readme

Author: pspanja

README.md

@@ -13,6 +13,8 @@ This only lists all implemented features, see the
 [documentation](https://docs.netgen.io/projects/search-extra)
 for more details on specific ones.
 
+- [Extensible DocumentFactory](https://docs.netgen.io/projects/search-extra/en/latest/reference/document_factory.html) (`elastic`) 
+
 - Support for [asynchronous indexing](https://docs.netgen.io/projects/search-extra/en/latest/reference/asynchronous_indexing.html) (`solr`, `legacy`)
 
 - [`ContentName`](https://github.com/netgen/ibexa-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/ContentName.php) criterion that works on matched translation's Content name (`solr`, `legacy`)
@@ -23,7 +25,7 @@ for more details on specific ones.
 
   Supported operators are: `EQ`, `IN`, `GT`, `GTE`, `LT`, `LTE`, `BETWEEN`.
 
-- [`Visible`](https://github.com/netgen/ibexa-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/Visible.php) criterion (`solr`, `legacy`),
+- [`Visible`](https://github.com/netgen/ibexa-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/Visible.php) criterion (`solr`, `elastic`, `legacy`),
   usable in both Content and Location search. The criterion works on compound visibility of Content and Location objects:
   the Content is visible if it's marked as visible; the Location is visible if it's marked as visible, is not hidden by
   one of its ancestor Locations, and it's Content is visible.

docs/reference/document_mapper.rst docs/reference/document_factory.rstdocs/reference/document_mapper.rst renamed to docs/reference/document_factory.rst

@@ -1,5 +1,6 @@
-DocumentFactory
-===============
+Extensible DocumentFactory
+==========================
+
 DocumentFactory is an implementation of field mappers for Elasticsearch modeled after the Solr implementation using the
 template method pattern. It implements the Elasticsearch ``DocumentFactoryInterface`` and its methods ``fromContent()``
 and ``fromLocation()`` add fields to document. These methods index the fields from the suitable field mappers.
@@ -10,23 +11,32 @@ Compiler Pass since elasticsearch is not available directly from the bundle.
 To use this feature, ensure you have elasticsearch bundle added to your project.
 
 The ``DocumentFactory`` service uses all base field mapper services to index content into the correct document
-(content, location, or translation-dependent document)::
+(content, location, or translation-dependent document):
+
+* ``ContentFieldMapper``
+
+* ``LocationFieldMapper``
+
+* ``ContentTranslationFieldMapper``
+
+* ``LocationTranslationFieldMapper``
 
-    ContentFieldMapper
-    LocationFieldMapper
-    ContentTranslationFieldMapper
-    LocationTranslationFieldMapper
-    BlockFieldMapper
-    BlockTranslationFieldMapper
+* ``BlockFieldMapper``
+
+* ``BlockTranslationFieldMapper``
 
 These services are abstract classes containing methods ``accept()`` and ``mapFields()`` which are implemented by new
 field mappers as needed.
 
 To add a new field mapper, create a class that extends one of the base field mappers above, implements its methods, and
-registers the service with one of the following tags, depending on the base field mapper::
+registers the service with one of the following tags, depending on the base field mapper:
+
+* ``netgen.ibexa_search_extra.elasticsearch.field_mapper.content``
+
+* ``netgen.ibexa_search_extra.elasticsearch.field_mapper.location``
+
+* ``netgen.ibexa_search_extra.elasticsearch.field_mapper.content_translation``
+
+* ``netgen.ibexa_search_extra.elasticsearch.field_mapper.location_translation``
 
-    netgen.ibexa_search_extra.elasticsearch.field_mapper.content
-    netgen.ibexa_search_extra.elasticsearch.field_mapper.location
-    netgen.ibexa_search_extra.elasticsearch.field_mapper.content_translation
-    netgen.ibexa_search_extra.elasticsearch.field_mapper.location_translation
-    netgen.ibexa_search_extra.elasticsearch.field_mapper.block_translation
+* ``netgen.ibexa_search_extra.elasticsearch.field_mapper.block_translation``

docs/reference/index.rst

@@ -10,6 +10,6 @@ Reference
     spellcheck_suggestions
     extra_fields
     asynchronous_indexing
-    document_mapper
+    document_factory
 
 .. include:: /reference/map.rst.inc

docs/reference/map.rst.inc

@@ -4,4 +4,4 @@
 * :doc:`/reference/subdocuments`
 * :doc:`/reference/spellcheck_suggestions`
 * :doc:`/reference/extra_fields`
-* :doc:`/reference/document_mapper`
+* :doc:`/reference/document_factory`