How to Help
===========

Documentation
-------------

For simple edits of the documentation just go to the page and click *Show/Edit on Github* on the left side, fork the repo, edit it, and submit a pull request.

For more complex additions I direct you to documentation for the projects we use:

- reStructuredText_ for the markup language.
- Pandoc_ for converting existing docs.
- Github_ and ReadTheDocs_ for hosting.
- Sphinx_ for generating the docs.

.. _Documentation: https://github.com/zoitechat/documentation
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
.. _ReadTheDocs: http://read-the-docs.readthedocs.org/en/latest/
.. _Github: https://help.github.com/
.. _Pandoc: http://johnmacfarlane.net/pandoc/README.html

Bug Reports
-----------

We use `Github Issues <https://github.com/zoitechat/zoitechat/issues>`_ for our bug reports. Be sure to search on there for similar issues before posting your own, if it already exists pointing out you also have the issue never hurts. With the bug report include at minimum the information from *help -> about*.

.. note::

    Issues is not a forum for asking questions, please direct those to IRC for now.

IRC Support
-----------

Anybody who enjoys helping others and understands much of what's on this site is welcome to help new users in either of our official irc channels: on Zoite, `#zoitechat <ircs://irc.zoite.net/zoitechat>`_ or on Libera.Chat, `#zoitechat <ircs://irc.libera.chat/zoitechat>`_.
