docs: readdocs updated

docs/developer/developer.md

@@ -1,2 +1,16 @@
 (developer)=
-# Developer
+# Development
+
+To contribute to the development of BEC Widgets, start by setting up the development environment:
+
+1. **Clone the Repository**: 
+```bash
+git clone https://gitlab.psi.ch/bec/bec-widgets
+cd bec-widgets
+```
+2. **Install in Editable Mode**:
+
+Installing the package in editable mode allows you to make changes to the code and test them in real-time.
+```bash
+pip install -e .[dev]
+```

docs/index.md

@@ -9,29 +9,31 @@
 :link: introduction
 :link-type: ref
 
-General information about BEC Widgets.
+General information.
 ```
 
 ```{grid-item-card}  User
 :link: user
 :link-type: ref
 
-Information for users of BEC Widgets.
+Information for users.
 ```
 
 ```{grid-item-card}  Developer
 :link: developer
 :link-type: ref
 
-Information for developers of BEC Widgets.
+Information for developers.
 ```
 ````
 
 
 ```{toctree}
-:maxdepth: 2
+---
+numbered: true
+maxdepth: 1
+---
 
 introduction/introduction
 user/user
 developer/developer
-```

docs/introduction/introduction.md

@@ -1,2 +1,18 @@
 (introduction)=
 # Introduction
+
+## Overview
+
+BEC Widgets is a GUI framework developed with beamline scientists in mind, aiming to provide a modern and modular environment for interacting with experiments. This package offers a suite of widgets specifically designed to enhance the workflow of beamline experiments, including features for running scans and data visualization.
+
+Targeting the unique needs of beamline scientists, BEC Widgets stands out with its modular approach to widget design and high customizability. This flexibility allows for tailored solutions that meet the specific requirements of each beamline.
+
+**Key Features**:
+
+- **Integration:** Seamlessly integrates with [BEC (Beamline Experiment Control)](https://gitlab.psi.ch/bec/bec), ensuring a cohesive and efficient experiment control experience.
+- **Support for PyQt5 and PyQt6:** Provides compatibility with both PyQt5 and PyQt6, offering versatility in your development environment.
+- **Widget Modularity:** Features modular widgets that can be easily combined to create customized applications, perfectly aligning with the diverse needs of beamline experiments.
+
+## Getting Started
+
+For detailed usage instructions and examples showcasing the practical applications of BEC Widgets, please refer to the [User](#user) section. Developers interested in contributing or customizing BEC Widgets can find more information in the [Developer](#developer) section.

docs/user/apps.md

@@ -0,0 +1,39 @@
+(user.apps)=
+# Applications
+
+In the `bec_widgets/examples` directory, you will find practical applications that demonstrate the capabilities of BEC Widgets in real-world scenarios. These applications showcase the adaptability and functionality of the framework for various beamline experiment needs.
+
+**Motor Alignment Tool**
+
+This tool assists in aligning motors with samples during experiments. It enables users to move motors, visually track their movement, and record positions for precise alignment.
+
+- **Location:** `bec_widgets/examples/motor_movement`
+- **Further Details:** [Motor Alignment Tool Documentation](#user.apps.motor_app) 
+
+**General Plotting Live Acquisition Tool**
+
+This application is designed for live data visualization. It allows users to view real-time signals from detectors in a multi-grid layout, facilitating immediate analysis during experiments.
+
+- **Location:** `bec_widgets/examples/plot_app`
+- **Further Details:** [General Plotting Live Acquisition Tool Documentation](#user.apps.plot_app) 
+
+
+**Modular Application**
+
+A bespoke application built entirely using BEC Widgets' modular components. This example illustrates the framework's flexibility in creating customized GUIs tailored to specific experimental setups.
+
+- **Location:** `bec_widgets/examples/modular_app`
+- **Further Details:** [Modular Application](#user.apps.modular_app) 
+
+---
+Note: The documentation for these applications is currently under development. The provided links will direct you to their respective pages once the documentation is complete.
+
+```{toctree}
+---
+maxdepth: 1
+hidden: true
+---
+
+apps/motor_app
+apps/plot_app
+apps/modular_app

docs/user/apps/modular_app.md

@@ -0,0 +1,6 @@
+(user.apps.modular_app)=
+
+# Modular Application
+
+
+_to be added..._

docs/user/apps/motor_app.md

@@ -0,0 +1,4 @@
+(user.apps.motor_app)=
+# Motor Alignment
+
+_to be added..._

docs/user/apps/plot_app.md

@@ -0,0 +1,6 @@
+(user.apps.plot_app)=
+
+# General Plotting Tool
+
+
+_to be added..._

docs/user/customisation.md

@@ -0,0 +1,13 @@
+(user.customisation)=
+# Customisation
+
+BEC Widgets are designed to be used with QtDesigner to quicly design GUI.
+
+
+## Example of promoting widgets in Qt Designer
+
+_Work in progress_
+
+## Implementation of plugins into Qt Designer
+
+_Work in progress_

docs/user/installation.md

@@ -0,0 +1,46 @@
+(user.installation)=
+# Installation
+
+
+**Prerequisites**
+
+Before installing BEC Widgets, please ensure the following requirements are met:
+
+1. **Python Version:** BEC Widgets requires Python version 3.9 or higher. Verify your Python version to ensure compatibility.
+2. **BEC Installation:** BEC Widgets works in conjunction with BEC. While BEC is a dependency and will be installed automatically, you can find more information about BEC and its installation process in the [BEC documentation](https://beamline-experiment-control.readthedocs.io/en/latest/).
+
+**Standard Installation**
+
+Install BEC Widgets using the pip package manager. Open your terminal and execute:
+
+```bash
+pip install bec-widgets
+```
+
+This command installs BEC Widgets along with its dependencies, including the default PyQt6.
+
+**Selecting a PyQt Version**
+
+BEC Widgets supports both PyQt5 and PyQt6. To install a specific version, use:
+
+For PyQt6:
+
+```bash
+pip install bec-widgets[pyqt6]
+```
+
+For PyQt5:
+
+```bash
+pip install bec-widgets[pyqt5]
+```
+
+**Troubleshooting**
+
+If you encounter issues during installation, particularly with PyQt, try purging the pip cache:
+
+```bash
+pip cache purge
+```
+
+This can resolve conflicts or issues with package installations.

docs/user/user.md

@@ -1,3 +1,38 @@
 (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
+hidden: true
+---
+
+installation
+apps
+widgets
+customisation

docs/user/widgets.md

@@ -0,0 +1,6 @@
+(user.widgets)=
+# Widgets
+
+Guide to use widgets.
+
+_work in progress_