From f61a3e1000c15dd35b8d5e33c5ea9868c2c382f9 Mon Sep 17 00:00:00 2001
From: Mate Pek <mate.pek@gmail.com>
Date: Sat, 23 Sep 2023 11:54:41 +0700
Subject: [PATCH] doc improvements

---
 .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++-
 .vscode/launch.json                  |  8 ++--
 documents/support.md                 | 65 ++++++++++++++++------------
 3 files changed, 51 insertions(+), 33 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 0854a5c3..b16e9569 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -16,7 +16,7 @@ about: Create a report to help us improve
 **Checklist**
 
 - [ ] The issue is about this extension and NOT about a fork.
-- [ ] Check the [known issues](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/support.md#known-issues) list.
+- [ ] Checked the [ALL the SUPPORT](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/support.md) document.
 - [ ] The latest version of the extension was used.
 - [ ] It is not related to remote-vscode or I checked the following [issue](https://github.com/matepek/vscode-catch2-test-adapter/issues/201)
 - [ ] Imagine yourself into my position and think how hard to debug the issue without insufficient information.
@@ -69,7 +69,14 @@ about: Create a report to help us improve
 
 - Last extension version in which the feature were working:
 
-**Log** (optional but recommended)
+<details>
+  <summary>**Log** (optional but recommended)</summary>
+
+```js
+  <paste logs here>
+```
+
+</details>
 
 <!--
   PLEASE attach an EXTENSIVE log. A lot of times reportes just select what they think it is important and those logs sometime not sufficient.
diff --git a/.vscode/launch.json b/.vscode/launch.json
index abc851be..7defe9bf 100644
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@@ -12,11 +12,12 @@
         "--extensionTestsPath=${workspaceFolder}/out/test",
         "${workspaceFolder}/out/tmp/workspaceFolder"
       ],
-      "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "env": {
         "TESTMATE_DEBUG": "true",
         "C2_INTEGRATIONFROMVSCODE": "true"
-      }
+      },
+      "sourceMaps": true
     },
     {
       "type": "extensionHost",
@@ -29,7 +30,8 @@
       },
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "preLaunchTask": "preDebug",
-      "postDebugTask": "postDebug"
+      "postDebugTask": "postDebug",
+      "sourceMaps": true
     },
     {
       "type": "extensionHost",
diff --git a/documents/support.md b/documents/support.md
index 686fd2e6..18c1d715 100644
--- a/documents/support.md
+++ b/documents/support.md
@@ -2,36 +2,14 @@
 
 For support open an issue with **detailed** description and please attach logs.
 
-## Getting logs
-
-Set `testMate.cpp.log.logpanel: true` and check the VSCode oputput window. Change the window to "Test Explorer: ...". The log should be there.
-
-Or one can set the `testMate.cpp.log.logfile: "<full path>"`. In this case a logfile will be created to the given path. Close VSCode to flush the log before you attach to an issue.
-
-**Don't forget** to disable after it by un-setting. Unnecessary logging can have a performance impact on VSCode.
-
-## Known issues
-
-### for all
-
-- (2018-09-03) On windows the navigate to source button isn't working. It is a framework bug.
-
-### for Catch2
+BUT before that read ALL this document.
 
-- (2018-11-17) Catch2: Long (>80 character) filename, test-name or description can cause test-list parsing failures.
-  Workaround: `#define CATCH_CONFIG_CONSOLE_WIDTH 300` and it has to be defined before every `#include "catch.hpp"` lines.
-- (2020-04-19) Catch2 version < 2.11.4 have a parameter parsing problem issue which makes some test name restrictions. The extension will notify if you are affected.
-- (2020-12-05) Catch2 test result parsing can fail if the test outputs unescaped "xml-like" text: `<Pin:10>`.
+## Quick Tips
 
-### for doctest
-
-- (2019-12-27) doctest 2.3.6 is support file and line informations. Previous version will recognise the tests but navigation will be disabled.
-- (2021-10-22) doctest does not provide the skipped information at test listing phase so this extension does not mark the tests skipped.
-- (2021-11-20) doctest SubCase statuses are not set. No point to do int now because the framework doesn't provide partial result just overall result.
-
-## For self-service
-
-Check [CONTRIBUTING.md](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/CONTRIBUTING.md).
+- Do your test names matches the directory and pattern the extension is looking for?
+- Do your test exectuable depend on some dynamic library?
+- Did you set up the `cwd` working directory propery?
+- Did you read the rest of this document?
 
 ## F.A.Q
 
@@ -180,3 +158,34 @@ If you want dynamically set enviranment variables generate a file which contains
 >   }
 > }
 > ```
+
+## Getting logs
+
+Set `testMate.cpp.log.logpanel: true` and check the VSCode oputput window. Change the window to "Test Explorer: ...". The log should be there.
+
+Or one can set the `testMate.cpp.log.logfile: "<full path>"`. In this case a logfile will be created to the given path. Close VSCode to flush the log before you attach to an issue.
+
+**Don't forget** to disable after it by un-setting. Unnecessary logging can have a performance impact on VSCode.
+
+## Known issues
+
+### for all
+
+- (2018-09-03) On windows the navigate to source button isn't working. It is a framework bug.
+
+### for Catch2
+
+- (2018-11-17) Catch2: Long (>80 character) filename, test-name or description can cause test-list parsing failures.
+  Workaround: `#define CATCH_CONFIG_CONSOLE_WIDTH 300` and it has to be defined before every `#include "catch.hpp"` lines.
+- (2020-04-19) Catch2 version < 2.11.4 have a parameter parsing problem issue which makes some test name restrictions. The extension will notify if you are affected.
+- (2020-12-05) Catch2 test result parsing can fail if the test outputs unescaped "xml-like" text: `<Pin:10>`.
+
+### for doctest
+
+- (2019-12-27) doctest 2.3.6 is support file and line informations. Previous version will recognise the tests but navigation will be disabled.
+- (2021-10-22) doctest does not provide the skipped information at test listing phase so this extension does not mark the tests skipped.
+- (2021-11-20) doctest SubCase statuses are not set. No point to do int now because the framework doesn't provide partial result just overall result.
+
+## For self-service
+
+Check [CONTRIBUTING.md](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/CONTRIBUTING.md).