===========================================
Documentation Guide
===========================================

Contributing to the Documentation
-----------------------------------
This section will be dedicated to adding tutorials and for FLOSIC members to update the
documentation. To get started with Sphinx editing, please visit the `reStructuredText Primer`_


GitHub Editing Scheme
------------------------------------------
The GitHub editing scheme requires you to be acquainted with some GitHub fundamentals: Fetch, Pull, Commit, and Push.
If you have not used GitHub before, we recommend downloading the `GitHub Desktop`_ application.

.. image:: ../../_static/docu_guide/GitFlow.png
    :width: 70 %
    :align: center

.. image:: ../../_static/misc_images/underconst.png

.. Links
.. _reStructuredText Primer: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _GitHub Desktop: https://desktop.github.com/