ADD: front iamge to index (thanks @damien)

Author: 9and3

doc/_static/fron_log.png

@@ -1,4 +1,27 @@
 (contrib_guide)=
 # Contribute
 
-/// how to contribute to diffcheck
+We value all contributions to diffCheck, whether they are bug reports, feature requests, or pull requests. We have a few guidelines to ensure that the process is as smooth as possible.
+
+## How to contribute
+
+We welcome pull requests from everyone. Please have a look at the [issue](https://github.com/diffCheckOrg/diffCheck/issues) list to see if there is something you can help with. If you have a new feature in mind, please open an issue to discuss it first.
+
+To contribute, you will need to install your developer's environment to build the project. You can find the instructions in the [development installation guide](dev_documentation).
+
+Next, fall the following steps:
+
+1. Fork the diffCheck repository by clicking the **Fork** button on the [diffCheck repository](https://github.com/diffCheckOrg/diffCheck). Clone the repository to your local machine:
+
+    ```console
+    git clone https://github.com/YOUR_USERNAME/diffCheck.git
+    cd diffCheck
+    ```
+
+2. Next you will need to set up your development environment. You can find the instructions in the [development installation guide](dev_documentation).
+
+3. Create a new branch for your feature:
+
+    ```console
+    git checkout -b my-feature
+    ``` 

doc/_static/front_bothroundsquare.png

@@ -1,4 +1,4 @@
-.. _dev_documentation:
+.. _dev_df_doc:
 
 Developer documentation
 =======================

doc/_static/front_square.png

@@ -1,5 +1,7 @@
 .. currentmodule:: diffCheck
 
+.. _diffCheck_API:
+
 diffCheck Python API
 ====================
 

doc/contribute.md

@@ -3,6 +3,10 @@
 
 In DF we use `Sphinx` to generate the documentation. The documentation is written in `reStructuredText` and `Markdown` and the source files are located in the `doc` folder. The documentation is hosted on `ReadTheDocs` and is automatically updated when a new commit is pushed to the `main` branch.
 
+```{note}	
+  For more info on how to write `.rst` files, check this [reStructuredText](https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide/) guide.
+```	
+
 ## Build locally
 
 To build locally the documentation to test your changes:

doc/dev_documentation.rst

@@ -1,3 +1,5 @@
+.. _gh_dfcomp:
+
 DiffCheck Gh Components
 =======================
 

doc/diffCheck_PythonAPI.rst

@@ -1,7 +1,153 @@
-DiffCheck: CAD-Point cloud comparison
+.. _diffcheck_intro:
+
+DiffCheck: CAD-Scan comparison
 =====================================
 
-Description missing for DiffCheck
+diffCheck(DF) allows to *identify discrepancies across point clouds and 3D models of both individually machined timber pieces featuring various joints as well as fully assembled timber structures*. It can help you quantify the differences between the CAD and scanned fabricated structure, providing a comprehensive report that highlights the discrepancies.
+
+The software is designed to be user-friendly and can be used either via a Grasshopper plug-in or its Python API.
+
+The software is developed by the `Laboratory of Timber Construction (IBOIS)`_ and the `Laboratory for Creative Computation (CRCL)`_ at `Polytechnique Fédérale de Lausanne (EPFL)`_.
+
+.. raw:: html
+
+   <div style="text-align: center;">
+       <img src="_static/front_bothroundsquare.png" alt="diffCheck Front Image" style="background-color: transparent; width: 100%; max-width: 800px;">
+   </div>
+
+.. grid:: 3
+   :margin: 0
+   :padding: 0
+   :gutter: 0
+
+   .. grid-item-card:: Grasshoper plug-in
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      diffCheck is distributed as a Grasshopper plug-in, allowing users to easily compare CAD models with scanned point clouds comfortably within the Rhino environment.
+
+   .. grid-item-card:: GH documentation
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      We provide detailed documentation on how to use the software, including installation instructions, tutorials, and components descriptions.
+
+   .. grid-item-card:: Developer resources
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      diffCheck is also available as a Python API, allowing developers to integrate the software into their own workflows within the Rhino ecosystem. We also welcome contributions to the project!
+
+.. grid:: 3
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: qstart
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`zap;2em` Get start!
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: gh_dfcomp
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`book;2em` GHComponents
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: dev_df_doc
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`codespaces;2em` To the Dev docs
+
+.. grid:: 3
+   :margin: 0
+   :padding: 0
+   :gutter: 0
+
+   .. grid-item-card:: Tutorials
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      We provide a series of hands-on tutorials to help you get started with diffCheck. The tutorials are based on real timber structures and will guide you through the process of comparing CAD models with scanned point clouds.
+
+   .. grid-item-card:: Python API
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      If you prefer to work with Python, you can use diffCheck's Python API for Rhino. The API allows you to access the software's functionality directly from your Python scripts.
+
+   .. grid-item-card:: Open-source
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      diffCheck is an open-source project, and we welcome contributions from the community. If you have ideas for new features or improvements, feel free to get in touch!
+
+.. grid:: 3
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: df-tuto
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`beaker;2em` Learn diffCheck
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: diffCheck_API
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`terminal;2em` DF in Python
+
+    .. grid-item-card::
+      :columns: 12 6 6 4
+      :class-card: sd-border-0
+      :shadow: None
+
+      .. button-ref:: contrib_guide
+        :expand:
+        :ref-type: myst
+        :color: success
+        :click-parent:
+
+        :octicon:`heart;2em` Contribute
 
 .. toctree::
     :hidden:
@@ -25,3 +171,8 @@ Description missing for DiffCheck
     dev_documentation
     glossary
     change_log
+
+
+.. _Laboratory of Timber Construction (IBOIS): https://www.epfl.ch/labs/ibois/
+.. _Laboratory for Creative Computation (CRCL): https://www.epfl.ch/labs/crcl/
+.. _Polytechnique Fédérale de Lausanne (EPFL) : https://www.epfl.ch/en/

doc/documentation.md

@@ -1,4 +1,4 @@
-(quickstart)=
+(qstart)=
 # Quickstart
 
 /// a brief rer-intro on how to install and a basic example of a working full and small pipeline of diffCheck