index.rst

Open Loyalty Documentation

Open Loyalty is technology for loyalty solutions for starting new loyalty projects based on the Symfony Framework.

Note

This documentation assumes you have a working knowledge of the Symfony Framework. If you're not familiar with Symfony, please start with reading the Quick Tour from the Symfony documentation.

The User Guide

:doc:`The Open Loyalty's User Guide </userguide/index>` is a complete documentation for users.

.. toctree::
   :hidden:

   userguide/index

Developer Documentation

:doc:`The Developer's Guide </developer/index>` contains information for developers who want to know more about Open Loyalty architecture and used concepts. This guide helps to understand how Open Loyalty works.

.. toctree::
   :hidden:

   developer/index

The Cookbook

:doc:`The Open Loyalty's Cookbook </cookbook/index>` is a collection of solution articles helping you with some specific, narrow problems.

.. toctree::
   :hidden:

   cookbook/index

The REST API Reference

:doc:`The API guide </api/index>` covers the REST API of Open Loyalty platform.

.. toctree::
   :hidden:

   api/index