Document what to backup in Wallabag

[github/wallabag/wallabag.git] / docs / en / index.rst

wallabag documentation
======================

.. image:: ../img/wallabag.png
   :alt: wallabag logo
   :align: center

**wallabag** is a read-it-later application: it saves a web page by
keeping content only. Elements like navigation or ads are deleted.

.. tip::

    This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.

The main documentation for this application is organized into a couple sections:

* :ref:`user-docs`
* :ref:`dev-docs`

The documentation is available in other languages:

* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_

.. _user-docs:

.. toctree::
   :maxdepth: 2
   :caption: User documentation

   user/faq
   user/installation
   user/upgrade-2.0.x-2.1.1
   user/upgrade-2.1.x-2.1.y
   user/migration
   user/import
   user/create_account
   user/login
   user/configuration
   user/first_article
   user/errors_during_fetching
   user/annotations
   user/download_articles
   user/share
   user/filters
   user/tags
   user/android
   user/parameters
   user/backup

.. _dev-docs:

.. toctree::
   :maxdepth: 2
   :caption: Developer documentation

   developer/api
   developer/docker
   developer/documentation
   developer/translate
   developer/maintenance
   developer/redis
   developer/rabbitmq