From 2c64d33a2e7068fdeee77e4f027165abd936d6d1 Mon Sep 17 00:00:00 2001 From: LMBishop <13875753+LMBishop@users.noreply.github.com> Date: Tue, 29 Jun 2021 20:59:25 +0100 Subject: [ci skip] Add documentation type --- .github/ISSUE_TEMPLATE/documentation.yml | 22 ++++++++++++++++++++++ README.md | 22 +++++++++++----------- 2 files changed, 33 insertions(+), 11 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..28c95fb0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,22 @@ +name: Documentation +description: Suggest changes to the documentation/wiki +labels: ['docs', 'status: needs investigating'] +body: + - type: dropdown + id: type + attributes: + label: Type of Change + multiple: false + options: + - Fix typo + - Clarify ambigious information + - Add new information + validations: + required: true + - type: textarea + attributes: + label: Description of Change + description: | + Describe the change in full. + validations: + required: false diff --git a/README.md b/README.md index 54034172..b7f874a2 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,17 @@ Quests is split into separate modules: For instructions on building Quests, see [Downloads / Building](#💾-Downloads-/-Building). +## 📖 Wiki +Quests provides a highly detailed and well maintained [wiki](https://github.com/LMBishop/Quests/wiki/). The information there is very useful to new users of the plugin. + +#### 🌟 Highlighted Articles +- [FAQs](https://github.com/LMBishop/Quests/wiki) +- [Tips](https://github.com/LMBishop/Quests/wiki/Tips) +- [Creating a Quest or Category](https://github.com/LMBishop/Quests/wiki/Creating-A-Quest-Or-Category) +- [Custom GUI Items](https://github.com/LMBishop/Quests/wiki/Custom-GUI-Items) +- [Task Types](https://github.com/LMBishop/Quests/wiki/Task-Types) +- [PlaceholderAPI](https://github.com/LMBishop/Quests/wiki/PlaceholderAPI) + ## 💡 Support For support please open a [GitHub issue](https://github.com/LMBishop/Quests/issues) or join our [Discord server](https://discord.gg/mQ2RcJC). Please provide information of the issue, any errors that may come up and make sure you are using the latest version of the plugin. @@ -85,14 +96,3 @@ Please speak English and do not use any vulgar or harmful language. We work on t The **source code** for Quests is licensed under the GNU General Public License v3.0, to view the license click [here](https://github.com/LMBishop/Quests/blob/master/LICENSE.txt). The **artwork** for Quests is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License ![](https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png), to learn more click [here](https://creativecommons.org/licenses/by-nc-sa/4.0/). - -## 📖 Wiki -Quests provides a highly detailed and well maintained [wiki](https://github.com/LMBishop/Quests/wiki/). The information there is very useful to new users of the plugin. - -#### 🌟 Highlighted Articles -- [FAQs](https://github.com/LMBishop/Quests/wiki) -- [Tips](https://github.com/LMBishop/Quests/wiki/Tips) -- [Creating a Quest or Category](https://github.com/LMBishop/Quests/wiki/Creating-A-Quest-Or-Category) -- [Custom GUI Items](https://github.com/LMBishop/Quests/wiki/Custom-GUI-Items) -- [Task Types](https://github.com/LMBishop/Quests/wiki/Task-Types) -- [PlaceholderAPI](https://github.com/LMBishop/Quests/wiki/PlaceholderAPI) \ No newline at end of file -- cgit v1.2.3-70-g09d2