.. _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/testing


.. panels::
    :card: + intro-card text-center

    ---

    Overview
    ^^^^^^^^

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

    +++

    .. link-button:: user_guide/overview
            :type: ref
            :text: Overview
            :classes: btn-block btn-secondary stretched-link

    ---

    Base Classes
    ^^^^^^^^^^^^

    The skbase class interface.

    +++

    .. link-button:: user_guide/base_classes
            :type: ref
            :text: Class Interface
            :classes: btn-block btn-secondary stretched-link

    ---

    Retrieval
    ^^^^^^^^^

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

    +++

    .. link-button:: user_guide/lookup
            :type: ref
            :text: Retrieval
            :classes: btn-block btn-secondary stretched-link

    ---

    Testing
    ^^^^^^^

    Tools for testing ``BaseObject``-s.

    +++

    .. link-button:: user_guide/testing
            :type: ref
            :text: Testing
            :classes: btn-block btn-secondary stretched-link