.. include:: ./vars.rst

Welcome to discord.js's documentation!
======================================

discord.js is an easy-to-use and intuitive JavaScript API for Discord_. It's fairly high level, so if you're
looking for something low level, check out `discord.io`_.

if you're having problems, check out the `troubleshooting guide`_.

Feel free to make any contributions you want, whether it be through creating an issue, giving a suggestion or making a pull request!

.. note:: This documentation is still a work-in-progress, apologies if something isn't yet documented!

.. _docs:

.. toctree::
   :maxdepth: 1
   :caption: General

   installing
   migrating
   troubleshooting
   examples

.. toctree::
   :maxdepth: 1
   :caption: Documentation

   docs_client
   docs_server
   docs_user
   docs_message
   docs_invite
   docs_voiceconnection

.. toctree::
   :maxdepth: 1
   :caption: Channel Documentation

   docs_channel
   docs_pmchannel
   docs_serverchannel
   docs_textchannel
   docs_voicechannel

.. toctree::
   :maxdepth: 1
   :caption: Permission Documentation

   docs_permissionconstants
   docs_role
   docs_permissionoverwrite
   docs_channelpermissions

.. toctree::
   :maxdepth: 1
   :caption: Utility Documentation

   docs_cache
   docs_equality
   docs_resolvables

.. _Discord : https://discordapp.com/
.. _troubleshooting guide : troubleshooting.html
.. _discord.io : https://github.com/izy521/discord.io
