Skip to content

Commit dc8667c

Browse files
tanchekweitanchekwei
committed
Update template and docs
1 parent 5abdefb commit dc8667c

6 files changed

Lines changed: 77 additions & 42 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ body:
66
attributes:
77
value: |
88
Thanks for taking the time to fill out this bug report!
9-
Please ensure you have read our [Troubleshooting Guide](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/troubleshooting-and-version-check.md) before submitting.
109
1110
- type: textarea
1211
id: bug-description
@@ -52,7 +51,7 @@ body:
5251
attributes:
5352
label: Extension Version
5453
description: |
55-
Refer to [How to check extension version](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/troubleshooting-and-version-check.md)
54+
Refer to [How to check extension version](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/check-extension-version.md)
5655
placeholder: e.g., 1.26.0.0
5756
validations:
5857
required: true
@@ -63,7 +62,7 @@ body:
6362
label: settings.json
6463
description: |
6564
Please provide the content of your `settings.json`.
66-
You can find it by following [these steps](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/troubleshooting-and-version-check.md).
65+
You can find it by following [these steps](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/locate-settings-json.md).
6766
placeholder: |
6867
```json
6968
// paste here
@@ -77,7 +76,7 @@ body:
7776
label: error.log
7877
description: |
7978
Please provide the content of your `error.log`.
80-
You can find it by following [these steps](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/troubleshooting-and-version-check.md).
79+
You can find it by following [these steps](https://github.com/tanchekwei/VisualStudioCodeForCommandPalette/blob/main/docs/locate-error-log.md).
8180
placeholder: |
8281
```text
8382
// paste here

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎docs/check-extension-version.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# How to check Extension Version
2+
3+
To help us diagnose and resolve issues, please provide the extension version.
4+
5+
## Method 1: Via the Extension (Recommended)
6+
7+
1. Launch the **Open Recent Visual Studio / Code** extension from the Command Palette.
8+
2. Right-click on any entry in the list.
9+
3. Click **Help**.
10+
4. **Extension Version** is displayed at the Help page.
11+
12+
## Method 2: Via Windows Settings
13+
14+
If you cannot open the extension:
15+
16+
1. Press `Win + R` on your keyboard.
17+
2. Type or paste the following and press Enter:
18+
```
19+
ms-settings:appsfeatures
20+
```
21+
3. In the search box, type:
22+
```
23+
Visual Studio / Code for Command Palette
24+
```
25+
4. Locate the app in the list.
26+
5. Click the **⋯ (three dots)** button next to the app and select **Advanced options**.
27+
6. You will find the **Version** displayed in the **Specifications** section.

‎docs/locate-error-log.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to locate error.log
2+
3+
To help us diagnose and resolve issues, please provide your `error.log`.
4+
5+
## Method 1: Via the Extension (Recommended)
6+
7+
1. Launch the **Open Recent Visual Studio / Code** extension from the Command Palette.
8+
2. Right-click on any entry in the list.
9+
3. Click **Help**.
10+
4. Click **Open Extension Settings / Logs Folder**.
11+
5. This will open File Explorer. Locate the file: `error.log`.
12+
13+
## Method 2: Manual Navigation
14+
15+
1. Open **File Explorer**.
16+
2. Navigate to:
17+
```
18+
%LOCALAPPDATA%\Packages\15722UsefulApp.WorkspaceLauncherforVSCode_s4b834ss2syh6\LocalState
19+
```
20+
3. Look for the file: `error.log`.

‎docs/locate-settings-json.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to locate settings.json
2+
3+
To help us diagnose and resolve issues, please provide your `settings.json`.
4+
5+
## Method 1: Via the Extension (Recommended)
6+
7+
1. Launch the **Open Recent Visual Studio / Code** extension from the Command Palette.
8+
2. Right-click on any entry in the list.
9+
3. Click **Help**.
10+
4. Click **Open Extension Settings / Logs Folder**.
11+
5. This will open File Explorer. Locate the file: `settings.json`.
12+
13+
## Method 2: Manual Navigation
14+
15+
1. Open **File Explorer**.
16+
2. Navigate to:
17+
```
18+
%LOCALAPPDATA%\Packages\15722UsefulApp.WorkspaceLauncherforVSCode_s4b834ss2syh6\LocalState
19+
```
20+
3. Look for the file: `settings.json`.

‎docs/troubleshooting-and-version-check.md‎

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,9 @@
1-
# Troubleshooting and Checking Extension Version
1+
# Troubleshooting Guide
22

3-
To help us diagnose and resolve issues more efficiently, please provide the extension version and relevant logs when submitting a bug report.
3+
To help us diagnose and resolve issues more efficiently, please refer to the following guides:
44

5-
## Method 1: Via the Extension (Recommended)
5+
* [How to check Extension Version](./check-extension-version.md)
6+
* [How to locate settings.json](./locate-settings-json.md)
7+
* [How to locate error.log](./locate-error-log.md)
68

7-
1. Launch the **Open Recent Visual Studio / Code** extension from the Command Palette.
8-
2. Right-click on any entry in the list.
9-
3. Click **Help**.
10-
- The **Extension Version** is displayed at the top of the Help page.
11-
4. Click **Open Extension Settings / Logs Folder**.
12-
- This will open the folder containing `error.log` and `settings.json`.
13-
- **Note:** Please attach both files when submitting your issue report.
14-
15-
## Method 2: Via Windows Settings
16-
17-
If you cannot open the extension, you can check the version through Windows Settings:
18-
19-
1. Press `Win + R` on your keyboard.
20-
2. Type or paste the following and press Enter:
21-
```
22-
ms-settings:appsfeatures
23-
```
24-
3. In the search box, type:
25-
```
26-
Visual Studio / Code for Command Palette
27-
```
28-
4. Locate the app in the list.
29-
5. Click the **⋯ (three dots)** button next to the app and select **Advanced options**.
30-
6. You will find the **Version** displayed in the **Specifications** section.
31-
32-
## Locating logs manually
33-
34-
If you cannot use the "Open Extension Settings / Logs Folder" shortcut, you can find the files here:
35-
36-
1. Open **File Explorer**.
37-
2. Navigate to:
38-
```
39-
%LOCALAPPDATA%\Packages\15722UsefulApp.WorkspaceLauncherforVSCode_s4b834ss2syh6\LocalState
40-
```
41-
3. Look for `error.log` and `settings.json`.
9+
If you are using the extension, you can also access these directly via the **Help** menu by right-clicking any item in the list.

0 commit comments

Comments
 (0)