.. Tesy's Tagboard documentation master file


Welcome to the Tesy's Tagboard documentation!
======================================================================

Tesy's Tagboard is a booru-style imageboard application. It's been designed from the ground up to be easily self-hosted. See the :doc:`deployment` to get started.


Features
--------

TODO

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   deployment
   configuration/index
   faq
   documentation

How to contribute
-----------------

Tesy's Tagboard is open to contributions, but please be aware that the project is maintained by a small number of developers in their free time. Please read through the :doc:`contributing/development` guide to get started if you'd like to jump right in. Otherwise you might be interested in reading through the :doc:`architecture/index` breakdown to get a better idea of how everything fits together.

If you aren't able to contribute code, **don't worry!** There are plenty of other ways you may be able to contribute.

* First and foremost, bug reports help immensely to find where the application may be deficient or failing. If you find a bug please don't hesitate to `report an issue <https://github.com/cblanken/tesys_tagboard/issues/new>`__
* Translations! If you're a native or advanced speaker of any of the :ref:`supported languages <supported-languages>`, then please don't hesitate to help add missing translations and make any existing translations sound more natural.
* Verifying existing `bug reports <https://github.com/cblanken/tesys-tagboard/issues>` is also a huge help. It indicates to us that the bug is reproducible and isn't some one-off configuration problem and documenting any reproduction steps will help us triage and resolve issues more quickly.


.. toctree::
   :maxdepth: 2

   contributing/index


Architecture
------------

.. toctree::
   :maxdepth: 2

   architecture/index



Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`