openflexure-microscope-server/docs/source/webapp/index.rst
Richard a09d2411a0 Add documentation of the web app
A first pass of documentation describing the web app GUI.  Screenshots
are committed as LFS objects, I've been deliberately conservative here
(only png files in the docs/ directory are LFSed) to avoid messing
with any static files in the web app.
2021-09-21 14:04:08 +01:00

22 lines
1.1 KiB
ReStructuredText

Web Application interface
=========================
.. toctree::
:maxdepth: 2
:caption: Contents:
pane_navigate.rst
pane_capture.rst
pane_settings.rst
pane_gallery.rst
The main graphical interface for the OpenFlexure Microscope is implemented as a web application, which allows it to be accessed either through OpenFlexure Connect or a web browser. See the :doc:`../quickstart.rst` page for connection instructions. A "tour" should guide users through the interface when they connect for the first time, and introduce the key interface elements.
Interface structure
-------------------
The main interface has a tab bar on the left, which allows the operator to select different controls. By default, the "view" pane does not show any additional controls, and a video feed from the camera fills the window.
.. image:: pane_view.png
Selecting one of the tab icons on the left will bring up the corresponding interface. Most of the pages display the image on the right hand side, and add additional controls between the image display and the tab bar.