.. _user_guide:

==========
User Guide
==========

Welcome to ``predictably``'s user guide!

The purpose of the user guide is to provide further explanations and context
on how you can use ``predictably``'s functionality. Future documentation will also
provide a companion explanation of the algorithms and techniques available in
the package.

If your just looking for a technical specification of the functionality
that ``predictably`` provides, see the :ref:`api_ref`.

.. note::

    The user guide is under development. We have created a basic
    structure and are looking for contributions to develop the user guide
    further.

.. toctree::
   :maxdepth: 1
   :hidden:

   user_guide/overview
   user_guide/configuration


.. grid:: 1 2 2 2
    :gutter: 3

    .. grid-item-card:: Overview
        :text-align: left
        :link: user_guide/overview
        :link-type: doc

        Get an overview of ``predictably``'s interfaces and design patterns.

    .. grid-item-card:: Configuration
        :text-align: left
        :link: user_guide/configuration
        :link-type: doc

        Learn how you can configure ``predictably``.