diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 60 |
1 files changed, 38 insertions, 22 deletions
diff --git a/docs/index.rst b/docs/index.rst index 9a8a37f6..a6f16c81 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,41 +21,57 @@ for Discord. - Easy to use with an object oriented design - Optimised for both speed and memory -Documentation Contents ------------------------ +Getting started +----------------- -.. toctree:: - :maxdepth: 2 +Is this your first time using the library? This is the place to get started! + +- **First steps:** :doc:`intro` | :doc:`quickstart` | :doc:`logging` +- **Working with Discord:** :doc:`discord` | :doc:`intents` +- **Examples:** Many examples are available in the :resource:`repository <examples>`. + +Getting help +-------------- + +If you're having trouble with something, these resources might help. - intro - quickstart - migrating - logging - api +- Try the :doc:`faq` first, it's got answers to all common questions. +- Ask us and hang out with us in our :resource:`Discord <discord>` server. +- If you're looking for something specific, try the :ref:`index <genindex>` or :ref:`searching <search>`. +- Report bugs in the :resource:`issue tracker <issues>`. +- Ask in our :resource:`GitHub discussions page <discussions>`. Extensions ------------ +------------ + +These extensions help you during development when it comes to common tasks. .. toctree:: - :maxdepth: 3 + :maxdepth: 1 ext/commands/index.rst ext/tasks/index.rst +Manuals +--------- -Additional Information ------------------------ +These pages go into great detail about everything the API can do. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + + api + discord.ext.commands API Reference <ext/commands/api.rst> + discord.ext.tasks API Reference <ext/tasks/index.rst> - discord - intents - faq - whats_new - version_guarantees +Meta +------ -If you still can't find what you're looking for, try in one of the following pages: +If you're looking for something related to the project itself, it's here. + +.. toctree:: + :maxdepth: 1 -* :ref:`genindex` -* :ref:`search` + whats_new + version_guarantees + migrating |