docs: reshape welcome page and toctrees

dbbs-lab · Oct 9, 2024 · fd26887 · fd26887
1 parent 45d989b
commit fd26887
Show file tree

Hide file tree

Showing 16 changed files with 94 additions and 65 deletions.
diff --git a/docs/bsb/modules.rst b/docs/bsb/modules.rst
@@ -1,3 +1,5 @@
+.. _whole-api:
+
 bsb
 ===
 

diff --git a/docs/cli/cli-toc.rst b/docs/cli/cli-toc.rst
@@ -1,5 +1,5 @@
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: CLI
 
    intro

diff --git a/docs/cli/intro.rst b/docs/cli/intro.rst
@@ -1,3 +1,5 @@
+.. _cli-guide:
+
 ############
 Introduction
 ############

diff --git a/docs/components/intro.rst b/docs/components/intro.rst
@@ -0,0 +1,7 @@
+.. _main-components:
+
+============
+Introduction
+============
+
+
diff --git a/docs/config/configuration-toc.rst b/docs/config/configuration-toc.rst
@@ -1,5 +1,9 @@
+Configuration
+=============
+
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Configuration
 
    files

diff --git a/docs/connectivity/connectivity-toc.rst b/docs/connectivity/connectivity-toc.rst
@@ -1,3 +1,6 @@
+Connectivity
+============
+
 .. toctree::
    :maxdepth: 2
    :caption: Connectivity

diff --git a/docs/dev/documentation.rst b/docs/dev/documentation.rst
@@ -1,3 +1,5 @@
+.. _development-section:
+
 #############
 Documentation
 #############

diff --git a/docs/dev/faq.rst b/docs/dev/faq.rst
@@ -0,0 +1,5 @@
+.. _faq:
+
+###
+FAQ
+###
diff --git a/docs/getting-started/include_morphos.rst b/docs/getting-started/include_morphos.rst
@@ -199,13 +199,8 @@ Now that the configuration is prepared, we can compile our network using:
 .. grid:: 1 1 2 2
     :gutter: 1
 
-    .. grid-item-card:: :octicon:`database;1em;sd-text-warning` Simulations
-	    :link: simulation-guide
-	    :link-type: ref
-
-	    Learn how to simulate your network models
 
-    .. grid-item-card:: :octicon:`database;1em;sd-text-warning` Simulations
+    .. grid-item-card:: :octicon:`cpu;1em;sd-text-warning` Simulations
 	    :link: simulation-guide
 	    :link-type: ref
 
@@ -223,6 +218,12 @@ Now that the configuration is prepared, we can compile our network using:
 
 	    Explore more examples.
 
+    .. grid-item-card:: :octicon:`gear;1em;sd-text-warning` Components
+       :link: main-components
+       :link-type: ref
+
+       Explore more about the main components.
+
 
 Recap
 -----

diff --git a/docs/getting-started/installation.rst b/docs/getting-started/installation.rst
@@ -1,3 +1,5 @@
+.. _installation-guide:
+
 ============
 Installation
 ============
@@ -22,7 +24,7 @@ You can verify that the installation works with:
   # Create an empty scaffold network with the default configuration.
   scaffold = Scaffold()
 
-You can now head over to the :doc:`get started <getting-started>`.
+You can now head over to the :doc:`get started <getting-started_reconstruction>`.
 
 Parallel support
 ================

diff --git a/docs/getting-started/toc.rst b/docs/getting-started/toc.rst
@@ -2,7 +2,7 @@ Getting Started
 ===============
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
   :caption: Getting Started
 
   top-level-guide

diff --git a/docs/index.rst b/docs/index.rst
@@ -25,43 +25,55 @@ human-readable, multi-scale models!
 
 ----
 
-.. grid:: 1 1 2 2
+.. grid:: 1 1 4 2
     :gutter: 1
 
+    .. grid-item-card:: :octicon:`desktop-download;1em;sd-text-warning` Installation
+      :link: installation-guide
+      :link-type: ref
+
+      How to install the code.
+
     .. grid-item-card:: :octicon:`flame;1em;sd-text-warning` Get started
       :link: get-started
       :link-type: ref
 
       Get started with your first project!
 
-    .. grid-item-card:: :octicon:`tools;1em;sd-text-warning` Components
-       :link: components
+    .. grid-item-card:: :octicon:`device-camera-video;1em;sd-text-warning` Examples
+       :link: examples
        :link-type: ref
 
-       Learn how to write your own components to e.g. place or connect cells.
+       View examples explained step by step
 
-    .. grid-item-card:: :octicon:`database;1em;sd-text-warning` Simulations
-       :link: simulation-guide
+    .. grid-item-card:: :octicon:`repo-clone;1em;sd-text-warning` BSB - CLI
+       :link: cli-guide
        :link-type: ref
 
-       Learn how to simulate your network models
+       Learn how to use the CLI.
 
-    .. grid-item-card:: :octicon:`device-camera-video;1em;sd-text-warning` Examples
-       :link: examples
+    .. grid-item-card:: :octicon:`tools;1em;sd-text-warning` Contributing
+       :link: development-section
        :link-type: ref
 
-       View examples explained step by step
+       Help out the project by contributing code.
 
-    .. grid-item-card:: :octicon:`package-dependents;1em;sd-text-warning` Plugins
-       :link: plugins
+    .. grid-item-card:: :octicon:`gear;1em;sd-text-warning` Components
+       :link: main-components
        :link-type: ref
 
-       Learn to package your code for others to use!
+       Explore more about the main components.
+
+    .. grid-item-card:: :octicon:`briefcase;1em;sd-text-warning` Python API
+       :link: whole-api
+       :link-type: ref
+
+
+    .. grid-item-card:: :octicon:`info;1em;sd-text-warning` FAQ
+       :link: faq
+       :link-type: ref
 
-    .. grid-item-card:: :octicon:`mark-github;1em;sd-text-warning` Contributing
-       :link: https://github.com/dbbs-lab/bsb
 
-       Help out the project by contributing code.
 
 .. toctree::
    :maxdepth: 2
@@ -72,54 +84,25 @@ human-readable, multi-scale models!
    guides/toc
    examples/toc
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Configuration
-
-   config/configuration-toc
-
-
 .. toctree::
   :maxdepth: 2
   :caption: CLI
 
   cli/cli-toc
 
 .. toctree::
-  :maxdepth: 2
-  :caption: Topology
-
-  topology/topology-toc
-
-.. toctree::
-  :maxdepth: 2
-  :caption: Cell types
-
-  cells/cells-toc
-
-.. toctree::
-  :maxdepth: 2
-  :caption: Morphologies
-
-  morphologies/morphology-toc
-
-.. toctree::
-  :maxdepth: 2
-  :caption: Placement
-
-  placement/placement-toc
-
-.. toctree::
-  :maxdepth: 2
-  :caption: Connectivity
-
-  connectivity/connectivity-toc
+   :maxdepth: 2
+   :caption: Components
 
-.. toctree::
-  :maxdepth: 2
-  :caption: Simulation
+   components/intro
+   config/configuration-toc
+   topology/topology-toc
+   cells/cells-toc
+   morphologies/morphology-toc
+   placement/placement-toc
+   connectivity/connectivity-toc
+   simulation/simulation-toc
 
-  simulation/simulation-toc
 
 .. toctree::
    :maxdepth: 2
@@ -129,6 +112,12 @@ human-readable, multi-scale models!
    genindex
    py-modindex
 
+.. toctree::
+   :maxdepth: 1
+   :caption: FAQ
+
+   dev/faq
+
 .. toctree::
   :maxdepth: 2
   :caption: Developer Guides:

diff --git a/docs/morphologies/morphology-toc.rst b/docs/morphologies/morphology-toc.rst
@@ -1,3 +1,6 @@
+Morphology
+==========
+
 .. toctree::
    :maxdepth: 2
    :caption: Morphology

diff --git a/docs/placement/placement-toc.rst b/docs/placement/placement-toc.rst
@@ -1,3 +1,6 @@
+Placement
+=========
+
 .. toctree::
    :maxdepth: 2
    :caption: Placement

diff --git a/docs/simulation/simulation-toc.rst b/docs/simulation/simulation-toc.rst
@@ -1,3 +1,6 @@
+Simulation
+==========
+
 .. toctree::
    :maxdepth: 2
    :caption: Simulation

diff --git a/docs/topology/topology-toc.rst b/docs/topology/topology-toc.rst
@@ -1,3 +1,6 @@
+Topology
+========
+
 .. toctree::
    :maxdepth: 2
    :caption: Topology
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _whole-api:
     bsb
     ===
@@ Expand Down @@