Merge remote-tracking branch 'lethosor/docs-support-channels' into master

conf.py

@@ -209,7 +209,7 @@ extlinks = {
     'bug': ('https://www.bay12games.com/dwarves/mantisbt/view.php?id=%s',
             'Bug '),
     'source': ('https://github.com/DFHack/dfhack/tree/develop/%s', ''),
-    'source:scripts': ('https://github.com/DFHack/scripts/tree/master/%s', ''),
+    'source-scripts': ('https://github.com/DFHack/scripts/tree/master/%s', ''),
     'issue': ('https://github.com/DFHack/dfhack/issues/%s', 'Issue '),
     'commit': ('https://github.com/DFHack/dfhack/commit/%s', 'Commit '),
 }

docs/Core.rst

@@ -492,7 +492,7 @@ the root DF folder.
 
 .. admonition:: Tip
 
-    When developing scripts in the :source:scripts:`dfhack/scripts repo <>`,
+    When developing scripts in the :source-scripts:`dfhack/scripts repo <>`,
     it may be useful to add the path to your local copy of the repo with ``+``.
     This will allow you to make changes in the repo and have them take effect
     immediately, without needing to re-install or copy scripts over manually.

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:
+Getting help
-.. _support:
+============
-
+There are several support channels available - see `support` for details.
-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 <https://webchat.freenode.net/?channels=dfhack>`_
-- the `Bay12 DFHack thread <https://dfhack.org/bay12>`_
-- the `/r/dwarffortress <https://dwarffortress.reddit.com>`_ questions thread
-- the thread for the mod or Starter Pack you're using (if any)
-

docs/Lua API.rst

@@ -4377,7 +4377,7 @@ the extension omitted. For example:
 Scripts can also be placed in other folders - by default, these include
 :file:`raw/scripts` and :file:`data/save/{region}/raw/scripts`, but additional
 folders can be added (for example, a copy of the
-:source:scripts:`scripts repository <>` for local development). See
+:source-scripts:`scripts repository <>` for local development). See
 `script-paths` for more information on how to configure this behavior.
 
 If the first line of the script is a one-line comment (starting with ``--``),

docs/Support.rst

@@ -0,0 +1,28 @@
+.. _support:
+
+===============
+Getting Support
+===============
+
+DFHack has several ways to get help online, including:
+
+- The `DFHack Discord server <https://dfhack.org/discord>`__
+- The ``#dfhack`` IRC channel on `Libera <https://libera.chat/>`__
+- The `DFHack thread on the Bay 12 Forum <https://dfhack.org/bay12>`__
+
+Some additional, but less DFHack-specific, places where questions may be answered include:
+
+- The `/r/dwarffortress <https://dwarffortress.reddit.com>`_ questions thread on Reddit
+- If you are using a starter pack, the relevant thread on the `Bay 12 Forum <http://www.bay12forums.com/smf/index.php?board=2.0>`__ -
+  see the :wiki:`DF Wiki <Utility:Lazy_Newb_Pack>` 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 <https://dfhack.readthedocs.io>`__; search functionality available `here <search>`)
+- :wiki:`The DF wiki <>`

docs/guides/quickfort-user-guide.rst

@@ -1564,7 +1564,7 @@ Links
 -  :source:`Quickfort blueprints library <data/blueprints/library>`
 -  :forums:`Quickfort forum thread <176889>`
 -  :issue:`DFHack issue tracker <>`
--  :source:scripts:`Quickfort source code <internal/quickfort>`
+-  :source-scripts:`Quickfort source code <internal/quickfort>`
 
 **Related tools:**
 

index.rst

@@ -28,6 +28,7 @@ User Manual
 
    /docs/Introduction
    /docs/Installing
+   /docs/Support
    /docs/Core
    /docs/Plugins
    /docs/Scripts