Update template with pointers to docs

Marus · Nov 11, 2023 · 6328cbf · 6328cbf
1 parent 123ab47
commit 6328cbf
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -13,9 +13,14 @@ Please visit the correct repo to file an issue. If this is an issue with
 * RTOS Viewer: [https://github.com/mcu-debug/rtos-views](https://github.com/mcu-debug/rtos-views)
 * the debugger itself, continue below
 
+Please read our documentation as well. You have a lot of control over how Cortex-Debug works. Besides the top level [README.md](https://github.com/Marus/cortex-debug/blob/master/README.md), we have the following
+
+https://github.com/Marus/cortex-debug/wiki
+https://github.com/Marus/cortex-debug/wiki/Cortex-Debug-Under-the-hood
+https://github.com/Marus/cortex-debug/blob/master/debug_attributes.md
+
 **Describe the bug**
 A clear and concise description of what the bug is.
-
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Start debug session

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -13,6 +13,12 @@ Please visit the correct repo to file an feature request. If this is an feature
 * RTOS Viewer: [https://github.com/mcu-debug/rtos-views](https://github.com/mcu-debug/rtos-views)
 * the debugger itself, continue below
 
+Please read our documentation as well. You have a lot of control over how Cortex-Debug works. Besides the top level README.md, we have the following
+
+https://github.com/Marus/cortex-debug/wiki
+https://github.com/Marus/cortex-debug/wikiCortex-Debug-Under-the-hood
+https://github.com/Marus/cortex-debug/blob/master/debug_attributes.md
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]