.. _user_guide:

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

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

The purpose of the user guide is to provide further explanations and context
to developers who want to use ``skbase`` to help create their own
packages.

If your just looking for a technical specification of the functionality
that ``skbase`` 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/base_classes
   user_guide/lookup
   user_guide/validate
   user_guide/testing


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

    .. grid-item-card:: Overview
        :text-align: center

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

        +++

        .. button-ref:: user_guide/overview
            :color: primary
            :click-parent:
            :expand:

            Overview

    .. grid-item-card:: Base Classes
        :text-align: center

        The skbase class interface.

        +++

        .. button-ref:: user_guide/base_classes
            :color: primary
            :click-parent:
            :expand:

            Class Interface

    .. grid-item-card:: Retrieval
        :text-align: center

        Tools for collecting ``BaseObject``-s, and metadata on your project.

        +++

        .. button-ref:: user_guide/lookup
            :color: primary
            :click-parent:
            :expand:

            Retrieval

    .. grid-item-card:: Validation and Comparison
        :text-align: center

        Tools for validating and comparing ``BaseObject``-s.

        +++

        .. button-ref:: user_guide/validate
            :color: primary
            :click-parent:
            :expand:

            Validation and Comparison

    .. grid-item-card:: Testing
        :text-align: center

        Tools for testing ``BaseObject``-s.

        +++

        .. button-ref:: user_guide/testing
            :color: primary
            :click-parent:
            :expand:

            Testing