Some style updates to docs

docs/_toc.yml

@@ -4,14 +4,12 @@
 format: jb-book
 root: index
 parts:
-  - caption: Getting started
+  - caption: Getting started (Tutorial)
     chapters:
-    - file: getting_started/installation
-    - file: getting_started/first_stim
-    - file: getting_started/illusion
-    - file: getting_started/replicate
+    - file: getting_started/getting_started
   - caption: Topic guides
     chapters:
+    - file: topic_guides/topic_guides
     - file: topic_guides/organization
     - file: topic_guides/sets_papers
     - file: topic_guides/resolution
@@ -20,6 +18,5 @@ parts:
     - file: topic_guides/visual_noise
   - caption: Contributing
     chapters:
-    - file: contributing/stimulus
-    - file: contributing/set
+    - file: contributing/contribute
 

docs/contributing/contribute.md

@@ -0,0 +1,6 @@
+# Contribute to `stimupy`
+
+```{toctree}
+set
+stimulus
+```

docs/contributing/set.md

@@ -1 +1 @@
-# Contribute an exact stimulus set
+# Contribute an exact stimulus (set)

docs/contributing/stimulus.md

@@ -1 +1 @@
-# Contribute a stimulus
+# Contribute a parameterizable stimulus function

docs/getting_started/first_stim.md

@@ -141,7 +141,7 @@ plot_stim(ellipse)
 plt.show()
 ```
 
-## Masked regions, and composition
+## Masked regions
 
 Another key in the stimulus-{glue:}`type` not addressed yet, is the `"shape_mask"`.
 This too is a {glue:}`imgtype`, with the same shape as `"img"`
@@ -172,7 +172,7 @@ plt.show()
 In a given mask, a pixel can only belong to a single region.
 A stimulus can have multiple different masks, each for different sets of regions.
 
-### Composition
+## Composition
 
 Another use of region masking
 is to compose more complicated stimuli
@@ -215,7 +215,7 @@ The advantages of this are:
 1. the actual image can easily be integrated in existing codebases:
    - save to file using `numpy.save()`, `matplotlib.save()`, or `Pillow`
    - manipulate using any `numpy`-based code
-   - TODO: import in PsychoPy (?)
+   % TODO: import in PsychoPy (?)
 2. anything that is compliant with this basic structure
    can use (some of) `stimupy` tooling,
    e.g., `plot_stim()`

docs/getting_started/getting_started.md

@@ -0,0 +1,9 @@
+# Getting started with `stimupy`
+
+```{toctree}
+:numbered:
+installation
+first_stim
+illusion
+replicate
+```

docs/getting_started/installation.md

@@ -2,7 +2,7 @@
 
 :::::{tab-set}
 
-::::{tab-item} pip
+::::{tab-item} pip {fab}`python`
 `stimupy` is not (yet) available on PyPI
 -- but if it was, one could:
 
@@ -18,13 +18,13 @@ pip install 'stimupy @ https://github.com/computational-psychology/stimupy'
 
 ::::
 
-::::{tab-item} conda-forge
+::::{tab-item} conda-forge 
 Surely this must also be possible...
 ::::
 
-::::{tab-item} source (GitHub)
+::::{tab-item} source (GitHub) {fab}`github`
 
-1. Clone the repository from GitHub (TUB):
+1. Clone the repository from GitHub:
 
     ```bash
     git clone git@github.com:computational-psychology/stimupy.git

docs/index.md

@@ -1,6 +1,27 @@
 # stimupy
 
-Welcome to stimupy
+Welcome to `stimupy`
 
-```{tableofcontents}
-```
+::::{grid} 2
+:gutter: 3
+
+:::{grid-item-card} Get started 🏃
+:link: getting_started/getting_started
+:link-type: doc
+:::
+
+:::{grid-item-card} Learn more 🧑‍🏫
+:link: topic_guides/topic_guides
+:link-type: doc
+:::
+
+:::{grid-item-card} Reference 📑
+
+:::
+
+:::{grid-item-card} Contribute 🎁
+:link: contributing/contribute
+:link-type: doc
+:::
+
+::::

docs/topic_guides/topic_guides.md

@@ -0,0 +1 @@
+# Topic Guides