Sylius/docs/index.rst
2017-02-02 08:58:17 +01:00

127 lines
2.3 KiB
ReStructuredText

Sylius Documentation
====================
.. image:: /_images/logo.png
:alt: Sylius Welcome Page
`Sylius`_ is a modern e-commerce solution for PHP, based on
`Symfony Framework`_.
.. note::
This documentation assumes you have a working knowledge of the Symfony
Framework. If you haven't, please start by reading the `Quick Tour`_ from
the Symfony documentation.
The Book
--------
The Developer's guide to leveraging the flexibility of Sylius. Here you will find all the concepts used in Sylius.
:doc:`The Book </book/index>` helps to understand how Sylius works.
.. toctree::
:hidden:
book/index
.. include:: /book/map.rst.inc
The Customization Guide
-----------------------
:doc:`The Customization Guide </customization/index>` is helpful while wanting to adapt Sylius to your personal business needs.
.. toctree::
:hidden:
customization/index
.. include:: /customization/map.rst.inc
The REST API Reference
----------------------
:doc:`The API guide </api/index>` covers the REST API of Sylius platform.
.. toctree::
:hidden:
api/index
.. include:: /api/map.rst.inc
The Cookbook
------------
:doc:`The Cookbook </cookbook/index>` is a collection of specific solutions for specific needs.
.. toctree::
:hidden:
cookbook/index
.. include:: /cookbook/map.rst.inc
The Behat Guide
---------------
In :doc:`the behat Guide </behat/index>` you will learn how to write clean and reusable features, contexts and pages.
.. toctree::
:hidden:
behat/index
.. include:: /behat/map.rst.inc
Bundles
-------
:doc:`Documentation of all Sylius bundles </bundles/index>`.
.. toctree::
:hidden:
bundles/index
.. include:: /bundles/map.rst.inc
Components
----------
:doc:`E-Commerce components for PHP documentation </components/index>`.
.. toctree::
:hidden:
components/index
.. include:: /components/map.rst.inc
The Contribution Guide
----------------------
:doc:`The Contribution Guide </contributing/index>` to Sylius.
.. toctree::
:hidden:
contributing/index
.. include:: /contributing/map.rst.inc
Support
-------
:doc:`The Support section </support/index>` for Sylius.
.. toctree::
:hidden:
support/index
.. include:: /support/map.rst.inc
.. _Sylius: http://sylius.org
.. _`Symfony Framework`: http://symfony.com
.. _`Quick Tour`: http://symfony.com/doc/current/quick_tour