MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move support docs to the intro page 

but leave an orphan link to the new section in case external links still
point to the old page
develop
myk002 2022-07-22 14:37:47 -07:00
parent 6a31b316dc
commit 2fd6d528ce
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
3 changed files with 35 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/Introduction.rst
Unescape Escape View File

@ -21,7 +21,7 @@ enhancements by default, and more can be enabled. There are also many tools
You can even add third-party scripts and plugins to do almost anything! You can even add third-party scripts and plugins to do almost anything!
For modders, DFHack makes many things possible. Custom reactions, new For modders, DFHack makes many things possible. Custom reactions, new
interactions, magic creature abilities, and more can be set through `DFHack tools <tools-index>` interactions, magic creature abilities, and more can be set through `DFHack tools <genindex>`
and custom raws. Non-standard DFHack scripts and inits can be stored in the and custom raws. Non-standard DFHack scripts and inits can be stored in the
raw directory, making raws or saves fully self-contained for distribution - raw directory, making raws or saves fully self-contained for distribution -
or for coexistence in a single DF install, even with incompatible components. or for coexistence in a single DF install, even with incompatible components.
@ -66,6 +66,36 @@ used by the DFHack console.
When that is not appropriate because they merely add keybinding hints to When that is not appropriate because they merely add keybinding hints to
existing DF screens, they deliberately use red instead of green for the key. existing DF screens, they deliberately use red instead of green for the key.
.. _support:
Getting help Getting help
============ ============
There are several support channels available - see `support` for details.
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/>`__
- GitHub:
- for bugs, use the :issue:`issue tracker <>`
- for more open-ended questions, use the `discussion board
<https://github.com/DFHack/dfhack/discussions>`__. Note that this is a
relatively-new feature as of 2021, but maintainers should still be
notified of any discussions here.
- 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 <>`

35
docs/Support.rst
Unescape Escape View File

@ -1,34 +1,3 @@
.. _support: :orphan:
=============== Please continue to the new `support` page.
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/>`__
- GitHub:
- for bugs, use the :issue:`issue tracker <>`
- for more open-ended questions, use the `discussion board
<https://github.com/DFHack/dfhack/discussions>`__. Note that this is a
relatively-new feature as of 2021, but maintainers should still be
notified of any discussions here.
- 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 <>`

3
index.rst
Unescape Escape View File

@ -27,9 +27,8 @@ User Manual
/docs/Introduction /docs/Introduction
/docs/Installing /docs/Installing
/docs/Support
/docs/Core /docs/Core
/docs/Tags /docs/Categories
/docs/guides/index /docs/guides/index
/docs/index-dev /docs/index-dev
/docs/index-about /docs/index-about