add sphinx-design boxes

docs/conf.py

@@ -15,6 +15,7 @@
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
     "myst_parser",
+    "sphinx_design",
 ]
 
 source_suffix = [".rst", ".md"]

docs/index.md

@@ -28,6 +28,82 @@ Source code on GitHub <https://github.com/mdtanker/invert4geom>
 :start-after: <!-- SPHINX-START -->
 ```
 
+::::{grid} 2
+:::{grid-item-card}  {octicon}`rocket` Getting started?
+:text-align: center
+New to Invert4geom? Start here!
+```{button-ref} overview
+    :click-parent:
+    :color: primary
+    :outline:
+    :expand:
+```
+:::
+
+:::{grid-item-card} {octicon}`comment-discussion` Need help?
+:text-align: center
+Start a discussion on GitHub!
+```{button-link} https://github.com/mdtanker/invert4geom/discussions
+    :click-parent:
+    :color: primary
+    :outline:
+    :expand:
+    Discussions
+```
+:::
+
+:::{grid-item-card} {octicon}`file-badge` Reference documentation
+:text-align: center
+
+A list of modules and functions
+
+```{button-ref} api/invert4geom
+    :click-parent:
+    :color: primary
+    :outline:
+    :expand:
+```
+:::
+
+:::{grid-item-card} {octicon}`bookmark` Using Invert4geom for research?
+:text-align: center
+
+Citations help support our work
+
+```{button-ref} citing
+    :click-parent:
+    :color: primary
+    :outline:
+    :expand:
+```
+:::
+
+::::
+
+```{admonition} Early-stages of development
+:class: seealso
+
+This package is at the very beginning of it's development! This means that we are still adding a lot of new features and sometimes we
+make changes to the ones we already have while we try to improve the
+software based on users' experience, test new ideas, take better design
+decisions, etc.
+Some of these changes could be **backwards incompatible**. Keep that in
+mind before you update Harmonica to a newer version.
+```
+
+```{admonition} How to contribute
+:class: seealso
+
+Please, read our [Contributor Guide](https://github.com/mdtanker/invert4geom/blob/main/.github/CONTRIBUTING.md) to learn
+how you can contribute to the project.
+```
+
+```{note}
+*Many parts of this documentation was adapted from the* [Fatiando project](https://www.fatiando.org/).
+```
+
+
+
 ## Indices and tables
 
 - {ref}`genindex`

pyproject.toml

@@ -66,6 +66,7 @@ docs = [
   "sphinx_copybutton",
   "sphinx_autodoc_typehints",
   "furo>=2023.08.17",
+  "sphinx_design",
 ]
 
 [project.urls]