.. _Home:
Checksheet Manager Documentation
==============================================

Welcome to  `Checksheet Manager`_ 's documentation.
Checksheet Manager is a free online checksheet management system for educational institution.



.. image:: image/1.png
   :scale: 100 %
   :alt: alternate text




The code is open source, and `available on github`_. Any issues regarding installation or use of checksheet manager can be reported at  the `issues`_ page. 



The main documentation for checksheet manager is organized into a couple of sections:

* :ref:`general-docs`
* :ref:`Root User Documentation`
* :ref:`Advisor Documentation`
* :ref:`Student Documentation`
* :ref:`Developer Documentation`

.. _general-docs:

.. toctree::
   :maxdepth: 2
   :caption: General Overview

   general_introduction
   hierarchies
   strategies


.. toctree::
   :maxdepth: 2
   :glob:
   :caption: Root User Documentation

   root_introduction
   root_responsibilities
   root_interface
   root_relation

.. toctree::
   :maxdepth: 2
   :caption: Advisor Documentation

   advisor_introduction
   advisor_responsibilities
   advisor_interface
   advisor_relation

.. toctree::
   :maxdepth: 2
   :caption: Student Documentation

   student_introduction
   student_responsibilities
   student_interface
   student_relation

.. toctree::
   :maxdepth: 2
   :caption: Developer Documentation

   installation_instructions
   rest_api
   code_flow
   dev_words


*This documentation was written as a part of project for the class WRI 220(Technical Writing and Communication) for* `Dr Robert Folk`_.

.. _Dr Robert Folk: https://kutztownenglish.com/faculty/folk/
.. _Checksheet Manager: http://kucm.ankitgyawali.com
.. _available on github: https://github.com/ankitgyawali/checksheet-manager
.. _issues: https://github.com/ankitgyawali/checksheet-manager/issues