Unify landingpage - update unfold family table & redirect doc links

README.md

@@ -1,13 +1,13 @@
 # UnfoldStats
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://unfoldtoolbox.github.io/UnfoldStats.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://unfoldtoolbox.github.io/UnfoldStats.jl/dev/)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://unfoldtoolbox.github.io/UnfoldDocs/UnfoldStats.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://unfoldtoolbox.github.io/UnfoldDocs/UnfoldStats.jl/dev/)
 [![Build Status](https://github.com/unfoldtoolbox/UnfoldStats.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/unfoldtoolbox/UnfoldStats.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/unfoldtoolbox/UnfoldStats.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/unfoldtoolbox/UnfoldStats.jl)
 
-|rERP|EEG visualisation|EEG Simulations|BIDS pipeline|Decode EEG data|Statistical testing|
-|---|---|---|---|---|---|
-| <a href="https://github.com/unfoldtoolbox/Unfold.jl/tree/main"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623787-757575d0-aeb9-4d94-a5f8-832f13dcd2dd.png"></a> | <a href="https://github.com/unfoldtoolbox/UnfoldMakie.jl"><img  src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623793-37af35a0-c99c-4374-827b-40fc37de7c2b.png"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldSim.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623795-328a4ccd-8860-4b13-9fb6-64d3df9e2091.png"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldBIDS.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277622460-2956ca20-9c48-4066-9e50-c5d25c50f0d1.png"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldDecode.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277622487-802002c0-a1f2-4236-9123-562684d39dcf.png"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldStats.jl"><img  src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623799-4c8f2b5a-ea84-4ee3-82f9-01ef05b4f4c6.png"></a>|
+|Estimation|Visualisation|Simulation|BIDS pipeline|Decoding|Statistics|MixedModelling|
+|---|---|---|---|---|---|---|
+| <a href="https://github.com/unfoldtoolbox/Unfold.jl/tree/main"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623787-757575d0-aeb9-4d94-a5f8-832f13dcd2dd.png" alt="Unfold.jl Logo"></a> | <a href="https://github.com/unfoldtoolbox/UnfoldMakie.jl"><img  src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623793-37af35a0-c99c-4374-827b-40fc37de7c2b.png" alt="UnfoldMakie.jl Logo"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldSim.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623795-328a4ccd-8860-4b13-9fb6-64d3df9e2091.png" alt="UnfoldSim.jl Logo"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldBIDS.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277622460-2956ca20-9c48-4066-9e50-c5d25c50f0d1.png" alt="UnfoldBIDS.jl Logo"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldDecode.jl"><img src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277622487-802002c0-a1f2-4236-9123-562684d39dcf.png" alt="UnfoldDecode.jl Logo"></a>|<a href="https://github.com/unfoldtoolbox/UnfoldStats.jl"><img  src="https://github-production-user-asset-6210df.s3.amazonaws.com/10183650/277623799-4c8f2b5a-ea84-4ee3-82f9-01ef05b4f4c6.png" alt="UnfoldStats.jl Logo"></a>|<a href=""><img src="https://github.com/user-attachments/assets/ffb2bba6-3a30-48b7-9849-7d4e7195b297" alt="UnfoldMixedModels.jl logo"></a>|
 
 A toolbox for statistical testing of EEG/ERP data and Unfold.jl models.
 Build on the [Unfold](https://github.com/unfoldtoolbox/unfold.jl/).

docs/make.jl

@@ -38,7 +38,12 @@ makedocs(;
             "Two-stage multi parameter test (Hotelling's T-squared test)" => "generated/tutorial/test_splines.md",
             "**MixedModels** EEG + Cluster permutation test" => "generated/tutorial/lmm_clusterdepth.md",
         ],
+        "API / Docstrings" => "api.md",
     ],
 )
 
-deploydocs(; repo = "github.com/unfoldtoolbox/UnfoldStats.jl", devbranch = "main", push_preview = true)
+deploydocs(;
+    repo = "github.com/unfoldtoolbox/UnfoldStats.jl",
+    devbranch = "main",
+    push_preview = true,
+)

docs/src/api.md

@@ -0,0 +1,8 @@
+# API / Docstrings
+
+```@index
+```
+
+```@autodocs
+Modules = [UnfoldStats]
+```

docs/src/index.md

@@ -2,13 +2,46 @@
 CurrentModule = UnfoldStats
 ```
 
-# UnfoldStats
+# UnfoldStats.jl Documentation
+Welcome to [UnfoldStats.jl](https://github.com/unfoldtoolbox/UnfoldStats.jl): a Julia package for statistical testing of EEG/ERP data and [Unfold.jl](https://github.com/unfoldtoolbox/Unfold.jl) models.
 
-Documentation for [UnfoldStats](https://github.com/unfoldtoolbox/UnfoldStats.jl).
+```@raw html
+<div style="width:60%; margin: auto;">
+</div>
+```
+
+## Key features
+TBD
 
-```@index
+## Installation 
+```julia-repl
+julia> using Pkg; Pkg.add("UnfoldStats")
 ```
+For more detailed instructions please refer to [Installing Julia & Unfold Packages](https://unfoldtoolbox.github.io/UnfoldDocs/main/installation/).
+
+
+## Usage example
+TBD
+
+## Where to start: Learning roadmap
+### 1. First steps
+📌 Goal: TBD \
+🔗 TBD
+
+### 2. Intermediate topics
+📌 Goal: TBD \
+🔗 TBD
+
+### 3. Advanced topics
+📌 Goal: TBD \
+🔗 TBD
+
+
+## Statement of need 
+TBD
 
-```@autodocs
-Modules = [UnfoldStats]
+```@raw html
+<!---
+Note: The statement of need is also used in the `README.md`. Make sure that they are synchronized.
+-->
 ```