bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00
Code Activity

docs: review developer section; add introduction

Browse Source
This commit is contained in:
appel_c
2024-08-08 22:54:30 +02:00
parent a4a0bac3c1
commit 2af5c94913
6 changed files with 50 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/developer/developer.md
View File

@ -1,7 +1,9 @@
(developer)=
# Developer
Welcome to the BEC Widgets developer guide! This section is intended for developers who want to contribute to the development of BEC Widgets.
Welcome to the BEC Widgets developer guide! BEC Widgets is a framework for building graphical user interfaces (GUIs) for [BEC](https://bec.readthedocs.io/en/latest/), a Python package for beamline experiment control.
This guide targets readers who want to develop new widgets or extend existing ones. If your goal is to use BEC Widgets to build GUIs for your experiments, please refer to the [user guide](#user).
```{toctree}
---
@ -9,8 +11,8 @@ maxdepth: 2
hidden: true
---
getting_started/getting_started.md
widgets/widgets.md
introduction/introduction.md
widget_development/widget_development.md
api_reference/api_reference.md
```
@ -21,26 +23,28 @@ api_reference/api_reference.md
:gutter: 5
```{grid-item-card}
:link: developer.getting_started
:link: developer.introduction
:link-type: ref
:img-top: /assets/rocket_launch_48dp.svg
:text-align: center
## Getting Started
## Introduction
Learn how to install BEC Widgets and get started with the framework.
An introduction into the single-resposibility principle and the modular design of BEC Widgets.
```
```{grid-item-card}
:link: developer.widgets
:link: developer.widget_development
:link-type: ref
:img-top: /assets/apps_48dp.svg
:text-align: center
## Widgets
## Widget Development
Learn about the building blocks of larger applications: widgets.
Learn how to develop a new modular widget for BEC Widgets.
```
````
````{grid} 2