Red-DiscordBot/docs/index.rst
El Laggron ea77de5d56 [Docs] Getting started guide (#2659)
* Getting started guide

* Remove DigitalOcean referral link

* Fix typos and mispells, thanks to @Flame442

* Remove cogs.red hyperlink until it is finished

* Add towncrier entry

* Add prolog.txt

This is not necessary for this PR but all of the other cog guides rely on this file.
The cog guides are individual branches based on this one, which is why I'm adding this file right now.

* QA changes

* More QA changes

considering -> assuming
red is a girl, not non-binary
2019-10-03 12:47:46 -04:00

75 lines
1.3 KiB
ReStructuredText

.. Red - Discord Bot documentation master file, created by
sphinx-quickstart on Thu Aug 10 23:18:25 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _main:
Welcome to Red - Discord Bot's documentation!
=============================================
.. toctree::
:maxdepth: 1
:caption: Installation Guides:
install_windows
install_linux_mac
venv_guide
autostart_systemd
.. toctree::
:maxdepth: 2
:caption: Cog Reference:
cog_customcom
cog_downloader
cog_permissions
.. toctree::
:maxdepth: 2
:caption: User guides:
getting_started
.. toctree::
:maxdepth: 2
:caption: Red Development Framework Reference:
guide_migration
guide_cog_creation
framework_apikeys
framework_bank
framework_bot
framework_checks
framework_cogmanager
framework_commands
framework_config
framework_datamanager
framework_downloader
framework_events
framework_i18n
framework_modlog
framework_rpc
framework_utils
version_guarantees
.. toctree::
:maxdepth: 2
:caption: Changelogs:
changelog_3_1_0
.. toctree::
:maxdepth: 2
:caption: Others
host-list
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`