docs: improve getting started (#752)

Author: RobPasMue

doc/source/getting_started/compatibility.rst

@@ -0,0 +1,26 @@
+
+.. _ref_ansys_comp:
+
+Ansys version compatibility
+===========================
+
+The following table summarizes the compatibility matrix between the PyAnsys Geometry service
+and the Ansys product versions.
+
++---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
+| PyAnsys Geometry versions | Ansys Product versions | Geometry Service (dockerized) | Geometry Service (standalone) |          Discovery           |          SpaceClaim          |
++===========================+========================+===============================+===============================+==============================+==============================+
+|         ``0.2.X``         |          23R2          | :octicon:`check-circle-fill`  | :octicon:`check-circle-fill`  |      :octicon:`x-circle`     | :octicon:`check-circle-fill` |
++---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
+|         ``0.3.X``         |    23R2 (partially)    | :octicon:`check-circle-fill`  | :octicon:`check-circle-fill`  |      :octicon:`x-circle`     | :octicon:`check-circle-fill` |
++---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
+|         ``0.4.X``         |      24R1 onward       | :octicon:`check-circle-fill`  | :octicon:`check-circle-fill`  | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` |
++---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
+
+.. button-ref:: index
+    :ref-type: doc
+    :color: primary
+    :shadow:
+    :expand:
+
+    Go to Getting started

doc/source/getting_started/docker/index.rst

@@ -26,7 +26,7 @@ meaning that certain operations are not available or fail.
 
 Select the kind of Docker container you want to build:
 
-.. grid:: 1
+.. grid:: 2
 
    .. grid-item-card:: Windows Docker container
             :link: windows_container

doc/source/getting_started/faq.rst

@@ -0,0 +1,19 @@
+.. _ref_faq:
+
+Frequently asked questions
+==========================
+
+What is PyAnsys?
+----------------
+PyAnsys is a set of open source Python libraries that allow you to interface
+with Ansys Mechanical APDL, Fluent, AEDT, and other Ansys products.
+You can use PyAnsys libraries within a Python environment of your choice
+in conjunction with external Python libraries.
+
+.. button-ref:: index
+    :ref-type: doc
+    :color: primary
+    :shadow:
+    :expand:
+
+    Go to Getting started

doc/source/getting_started/index.rst

@@ -5,11 +5,14 @@ Getting started
 
 PyAnsys Geometry is a Python client library for the Ansys Geometry service.
 
+Available modes
+===============
+
 This client library works with a Geometry service backend. There are several ways of
 running this backend, although the preferred and high-performance mode is using Docker
 containers. Select the option that suits your needs best.
 
-.. grid:: 1
+.. grid:: 2
 
    .. grid-item-card:: Docker containers
             :link: docker/index
@@ -42,11 +45,24 @@ containers. Select the option that suits your needs best.
 
             Connect to an existing Geometry service locally or remotely.
 
+Compatibility with Ansys releases
+=================================
+
+PyAnsys Geometry continues to evolve as the Ansys products move forward. For
+more information, see :ref:`Ansys product version compatibility <ref_ansys_comp>`.
+
+Development installation
+========================
 
 In case you want to support the development of PyAnsys Geometry, install the repository
 in development mode. For more information, see
 :ref:`Install package in development mode <ref_dev_mode>`.
 
+Frequently asked questions
+==========================
+
+Any questions? Refer to :ref:`Q&A <ref_faq>` before submitting an issue.
+
 .. toctree::
    :hidden:
    :maxdepth: 2
@@ -55,4 +71,6 @@ in development mode. For more information, see
    local/index
    remote/index
    existing/index
+   compatibility
    installation
+   faq

doc/styles/Vocab/ANSYS/accept.txt

@@ -5,6 +5,7 @@ API
 api
 Direct API
 Dockerfile
+dockerized
 Fluent API
 Geometry
 geometry
@@ -16,6 +17,8 @@ namespace
 Polydata
 PROTO
 Protobuf
+PyAnsys
+pyansys
 pyansys-geometry
 PyAnsys Geometry
 PyPI