diff --git a/docs/Introduction.rst b/docs/Introduction.rst index f7525cb4f..27c887a8b 100644 --- a/docs/Introduction.rst +++ b/docs/Introduction.rst @@ -60,23 +60,6 @@ used by the DFHack console. background managing or changing some aspect of the game if you `enable` them. -.. _troubleshooting: -.. _support: - -Troubleshooting -=============== -Don't panic! Even if you need this section, it'll be OK :) - -If something goes wrong, check the log files in DF's folder -(``stderr.log`` and ``stdout.log``). Looking at these might help you - -or someone else - solve the problem. Take screenshots of any weird -error messages, and take notes on what you did to cause them. - -If the search function in this documentation isn't enough and -:wiki:`the DF Wiki <>` hasn't helped, try asking in: - -- the `#dfhack IRC channel on freenode `_ -- the `Bay12 DFHack thread `_ -- the `/r/dwarffortress `_ questions thread -- the thread for the mod or Starter Pack you're using (if any) - +Getting help +============ +There are several support channels available - see `support` for details. diff --git a/docs/Support.rst b/docs/Support.rst new file mode 100644 index 000000000..40b5f33a0 --- /dev/null +++ b/docs/Support.rst @@ -0,0 +1,28 @@ +.. _support: + +=============== +Getting Support +=============== + +DFHack has several ways to get help online, including: + +- The `DFHack Discord server `__ +- The ``#dfhack`` IRC channel on `Libera `__ +- The `DFHack thread on the Bay 12 Forum `__ + +Some additional, but less DFHack-specific, places where questions may be answered include: + +- The `/r/dwarffortress `_ questions thread on Reddit +- If you are using a starter pack, the relevant thread on the `Bay 12 Forum `__ - + see the :wiki:`DF Wiki ` for a list of these threads + +When reaching out to any support channels regarding problems with DFHack, please +remember to provide enough details for others to identify the issue. For +instance, specific error messages (copied text or screenshots) are helpful, as +well as any steps you can follow to reproduce the problem. Sometimes, log output +from ``stderr.log`` in the DF folder can point to the cause of issues as well. + +Some common questions may also be answered in documentation, including: + +- This documentation (`online here `__; search functionality available `here `) +- :wiki:`The DF wiki <>` diff --git a/index.rst b/index.rst index 4df56de58..2e5454f40 100644 --- a/index.rst +++ b/index.rst @@ -28,6 +28,7 @@ User Manual /docs/Introduction /docs/Installing + /docs/Support /docs/Core /docs/Plugins /docs/Scripts