docs: restructured docs layout

docs/user/api_reference/api_reference.md

@@ -0,0 +1,11 @@
+(user.api_reference)=
+# User API Reference
+
+```{eval-rst}
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+
+    bec_widgets.cli.client
+
+```

docs/user/applications/applications.md

@@ -1,4 +1,4 @@
-(user.apps)=
+(user.applications)=
 # Applications
 
 **Coming soon**

docs/user/getting_started/getting_started.md

@@ -0,0 +1,12 @@
+(user.getting_started)=
+# Getting Started
+This section provides a comprehensive guide to getting started with BEC Widgets. Whether you are new to BEC Widgets or looking to refresh your knowledge, this guide will help you set up and navigate the framework with ease.
+
+```{toctree}
+---
+maxdepth: 2
+hidden: true
+---
+
+getting_started/installation
+```

docs/user/getting_started/installation.md

@@ -14,7 +14,7 @@ Before installing BEC Widgets, please ensure the following requirements are met:
 Install BEC Widgets using the pip package manager. Open your terminal and execute:
 
 ```bash
-pip install bec_widgets
+pip install bec_widgets PyQt6
 ```
 
 This command installs BEC Widgets along with its dependencies, including the default PyQt6.

docs/user/user.md

@@ -1,38 +1,67 @@
 (user)=
 # User
-
-**Overview**
-
 Welcome to the User section of the BEC Widgets documentation! BEC Widgets is a versatile GUI framework tailored for beamline scientists, enabling efficient and intuitive interaction with beamline experiments. This section is designed to guide both new and experienced users through the essential aspects of utilizing BEC Widgets.
 
-**Key Topics**
-
-- [Installing BEC Widgets](#user.installation): Instructions for installing BEC Widgets on your system.
-
-- [Example Applications](#user.apps): Overview of bespoke applications and demonstrations of BEC Widgets in action, showcasing its use in real-world beamline scenarios.
-
-- [Widgets Overview](#user.widgets): Detailed information on the variety of widgets available, their functions, and how to use them effectively.
-
-- [Customization and Configuration](#user.customisation): Tips on customizing and configuring BEC Widgets to suit your specific experimental needs using Qt Designer.
-
-**Bug Reports and Feature Requests**
-
-We value your feedback and contributions to improving BEC Widgets. If you encounter any issues or have ideas for new features, we encourage you to report them.
-
-- **Bug Reports:** If you find a bug or an issue, please report it on our repository's [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened). We have a template for bug reporting to help you provide all necessary information.
-- **Feature Requests:** Have an idea for a new feature or an enhancement? Share it with us on the [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened) of our repository. We have a feature request template that you can use to describe your proposal.
-
-**Development**
-
-For advanced details about BEC Widgets’ internal architecture, development contributions, or customization techniques, please explore the [Developer](#developer) section. 
-
 ```{toctree}
 ---
-maxdepth: 3
+maxdepth: 2
 hidden: true
 ---
 
-installation
-apps
-widgets
-customisation
+getting_started/getting_started.md
+applications/applications.md
+widgets/widgets.md
+api_reference/api_reference.md
+```
+
+
+***
+
+````{grid} 2
+:gutter: 5
+
+```{grid-item-card}
+:link: user.getting_started
+:link-type: ref
+:img-top: /assets/rocket_launch_48dp.svg
+:text-align: center
+
+## Getting Started
+
+Learn how to install BEC Widgets and get started with the framework.
+```
+
+```{grid-item-card}
+:link: user.applications
+:link-type: ref
+:img-top: /assets/display_settings_48dp.svg
+:text-align: center
+
+## Applications
+
+Learn how to use BEC Widgets Applications, to modify and create new applications.
+
+```
+
+```{grid-item-card}
+:link: user.widgets
+:link-type: ref
+:img-top: /assets/apps_48dp.svg
+:text-align: center
+
+## Widgets
+
+Learn about the building blocks of larger applications: widgets.
+```
+
+```{grid-item-card} 
+:link: user.api_reference
+:link-type: ref
+:img-top: /assets/index_api.svg
+:text-align: center
+
+## API reference
+
+Comprehensive reference of all user-facing classes, functions, and methods.
+```
+````

docs/user/widgets/widgets.md

@@ -15,7 +15,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Customizable visual elements such as line color and style.
 
 **Example of Use:**
-![Waveform 1D](./widgets/w1D.gif)
+![Waveform 1D](./w1D.gif)
 ### 2D Scatter Plot
 
 **Purpose:** The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
@@ -27,7 +27,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Tools for selecting and inspecting specific data points.
 
 **Example of Use:**
-![Waveform 1D](./widgets/scatter_2D.gif)
+![Waveform 1D](./scatter_2D.gif)
 ### Motor Position Map
 
 **Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
@@ -38,4 +38,4 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Ability to record and recall specific motor positions for repetitive tasks.
 
 **Example of Use:**
-![Waveform 1D](./widgets/motor.gif)
+![Waveform 1D](./motor.gif)