Merge branch 'doc/overall_edit' of https://github.com/ansys-internal/…

…pymeilisearch into doc/overall_edit

README.rst

@@ -90,17 +90,15 @@ The `PyMeilisearch documentation`_ contains these sections:
 .. _user guide: https://pymeilisearch.docs.ansys.com/version/stable/user-guide/index.html
 .. _api reference: https://pymeilisearch.docs.ansys.com/version/stable/autoapi/index.html
 .. _examples: https://pymeilisearch.docs.ansys.com/version/stable/examples/index.html
-.. _PyMeilisearch Issues: https://github.com/ansys/pymeilisearch/issues
-.. _PyMeilisearch repository: https://github.com/ansys/pymeilisearch
 
 
-Issues
-======
+Troubleshooting
+===============
 
-On the `PyMeilisearch Issues`_ page, you can create issues to submit questions,
-report bugs, and request new features.
+For troubleshooting or reporting issues, please open an issue in the project
+repository.
 
-Here is the process for creating an issue:
+Please follow these steps to report an issue:
 
 #. Go to the `PyMeilisearch repsitory`_.
 #. Click the **Issues** tab to view the **Issues** page.

doc/source/examples.rst

@@ -32,7 +32,7 @@ This command create indexes from files in the repositories of GitHub organizatio
 Create an index from CI/CD
 --------------------------
 
-You can use PyMeilisearch within the `Ansys actions <https://actions.docs.ansys.com>`_ in your CI/CD. 
+You can use PyMeilisearch within the `Ansys actions <https://actions.docs.ansys.com>`_ in your CI/CD.
 The following tabs show how to use Ansys actions to create one or more indexes from online files,
 local files, and files in GitHub organizations:
 

doc/source/getting-started/index.rst

@@ -35,4 +35,4 @@ This section describes how to install and run PyMeilisearch.
 
    installing-pymeilisearch
    meilisearch-images
-   
+

doc/source/getting-started/meilisearch-images.rst

@@ -1,30 +1,11 @@
-Run Meilisearch
-###############
+Meilisearch images
+##################
 
-You can run a local instance of Meilisearch either from the
-command line or from an image in a Docker container.
+Running meilisearch using the command line
+==========================================
 
-.. note::
-
-    Both methods of running a local instance of Meilisearch require
-    a master key. To generate a master key, you can use one of
-    these tools:
-
-    - `UUID Generator <https://uuidgen.org/v/4>`_
-    - `OpenSSL <https://www.openssl.org/docs/man1.1.1/man1/rand.html>`_
-    - `shasum <https://linux.die.net/man/1/shasum>`_
-
-
-For more information, see the `Meilisearch Quick Start`_.
-
-.. _Meilisearch Quick Start: https://www.meilisearch.com/docs/learn/getting_started/quick_start
-
-
-Run Meilisearch from the command line
-======================================
-
-On the command line, first install the Meilisearch binaries with
-this command:
+It is possible to install and run a local instance of Meilisearch. Start by
+installing the binaries by running:
 
 .. code-block:: console
 
@@ -40,18 +21,17 @@ Meilisearch with these commands:
     ./meilisearch --master-key="$MEILI_MASTER_KEY"
 
 
-Run Meilisearch from a Docker image
-===================================
 
-In the `PyMeilisearch repository`_, the ``docker/`` directory  contains a
-``docker-compose.yml`` file.
+Running meilisearch using a Docker image
+========================================
 
-.. _PyMeilisearch repository: https://github.com/ansys/pymeilisearch
+A ``docker-compose.yml`` file is provided inside the ``docker/`` directory in
+the `pymeilisearch repository`_.
 
-You can use this YML file to run Meilisearch from this Docker image
-for development purposes.
+.. _pymeilisearch repository: https://github.com/ansys/pymeilisearch
 
-To run this Docker image, use these commands:
+This ``docker-compose.yml`` allows to run a local instance of Meilisearch for
+development purposes. The following command is used to run the image:
 
 .. code-block:: console
 

doc/source/user-guide/cli-usage.rst

@@ -8,9 +8,9 @@ the format type and location of the source files.
 
 .. note::
    You must declare two environment variables before using PyMeilisearch:
-   
+
    - ``MEILISEARCH_HOST_URL``: Registry endpoint for Meilisearch
-   - ``MEILISEARCH_API_KEY``: API key for creating indexes in the search registry 
+   - ``MEILISEARCH_API_KEY``: API key for creating indexes in the search registry
 
 
 Start PyMeilisearch
@@ -50,19 +50,13 @@ Here is the general syntax for the ``upload`` subcommand:
 As you can see, this command requires certain arguments and supports additional options, depending
 on your requirements.
 
-**Required arguments**
+.. _meilisearch-docs-scrapper: https://github.com/meilisearch/docs-scraper#set-your-config-file
 
-- ``--template <template>``: Name of the template or the file path where
-  the template is located. Available templates are ``sphinx_pydata`` and ``default``.
-  The configuration file for a template identifies which content to scrape.
-  For an example of a basic configuration file, see `Set your Config File
-  <https://github.com/meilisearch/docs-scraper#set-your-config-file>`_ in the README
-  for the Meilisearch ``docs-scraper`` repository.
+- ``--index <index name>`` indicates the name of the Meilisearch index used to identify the content.
+- ``<source>`` is the type source to upload. It can be ``html``, ``url``, or ``github``.
+- ``<location>`` indicates the location of the files or website to upload.
 
-- ``--index <index name>``: Name of the Meilisearch index to use to identify the content.
-- ``<source>``: Type of files to upload to Meilisearch. Options are ``html``, ``url``,
-  and ``github``.
-- ``<location>``: Directory path for the files or website to upload.
+Options:
 
 **Options**