From 2fd6d528ce084c87ebe1c2c923a734470a05cf7c Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 22 Jul 2022 14:37:47 -0700 Subject: [PATCH] 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 --- docs/Introduction.rst | 34 ++++++++++++++++++++++++++++++++-- docs/Support.rst | 35 ++--------------------------------- index.rst | 3 +-- 3 files changed, 35 insertions(+), 37 deletions(-) diff --git a/docs/Introduction.rst b/docs/Introduction.rst index 449f2d38a..ad24f8f43 100644 --- a/docs/Introduction.rst +++ b/docs/Introduction.rst @@ -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! For modders, DFHack makes many things possible. Custom reactions, new -interactions, magic creature abilities, and more can be set through `DFHack tools ` +interactions, magic creature abilities, and more can be set through `DFHack tools ` 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 - 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 existing DF screens, they deliberately use red instead of green for the key. +.. _support: + 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 `__ +- The ``#dfhack`` IRC channel on `Libera `__ +- GitHub: + - for bugs, use the :issue:`issue tracker <>` + - for more open-ended questions, use the `discussion board + `__. 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 `__ + +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/docs/Support.rst b/docs/Support.rst index 00e055baa..af8bd583c 100644 --- a/docs/Support.rst +++ b/docs/Support.rst @@ -1,34 +1,3 @@ -.. _support: +:orphan: -=============== -Getting Support -=============== - -DFHack has several ways to get help online, including: - -- The `DFHack Discord server `__ -- The ``#dfhack`` IRC channel on `Libera `__ -- GitHub: - - for bugs, use the :issue:`issue tracker <>` - - for more open-ended questions, use the `discussion board - `__. 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 `__ - -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 <>` +Please continue to the new `support` page. diff --git a/index.rst b/index.rst index 843797e4e..d627267f0 100644 --- a/index.rst +++ b/index.rst @@ -27,9 +27,8 @@ User Manual /docs/Introduction /docs/Installing - /docs/Support /docs/Core - /docs/Tags + /docs/Categories /docs/guides/index /docs/index-dev /docs/index-about