diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 116d66543..0ba8b6669 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve Jan title: 'bug: [DESCRIPTION]' labels: 'type: bug' assignees: '' @@ -10,7 +10,7 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +**Steps to reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' @@ -21,12 +21,14 @@ Steps to reproduce the behavior: A clear and concise description of what you expected to happen. **Screenshots** -If applicable, add screenshots to help explain your problem. +If applicable, add screenshots to help explain your issue. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Environment details** +- Operating System: [Specify your OS. e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc] +- Jan Version: [e.g., 0.1.3] +- Processor: [e.g., Apple M1, Intel Core i7, AMD Ryzen 5, etc] +- RAM: [e.g., 8GB, 16GB] +- Any additional relevant hardware specifics: [e.g., Graphics card, SSD/HDD] **Additional context** -Add any other context about the problem here. +Add any other context or information that could be helpful in diagnosing the problem. diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md index ab8622164..1ef7638f7 100644 --- a/docs/docs/guides/02-installation/01-mac.md +++ b/docs/docs/guides/02-installation/01-mac.md @@ -58,16 +58,16 @@ To reset your installation ```bash # Newer versions -rm -rf /Users/$(whoami)/Library/Application\ Support/jan +rm -rf ~/Library/Application\ Support/jan # Versions 0.2.0 and older -rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron +rm -rf ~/Library/Application\ Support/jan-electron ``` 3. Clear Application cache ```bash -rm -rf /Users/$(whoami)/Library/Caches/jan* +rm -rf ~/Library/Caches/jan* ``` 4. Use the following commands to remove any dangling backend processes: @@ -76,7 +76,7 @@ rm -rf /Users/$(whoami)/Library/Caches/jan* ps aux | grep nitro ``` -Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: +Look for processes like "nitro" and "nitro_arm_64", and kill them one by one with: ```bash kill -9 diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md index cfaee1f5b..e594e116a 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -51,13 +51,13 @@ C:\Users\{username}\AppData\Local\Programs\Jan ## Uninstalling Jan -To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). +To uninstall Jan on Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). -To remove all user data associated with Jan, you can delete the `/Jan` directory in Windows' [AppData directory](https://superuser.com/questions/632891/what-is-appdata). +To remove all user data associated with Jan, you can delete the `/jan` directory in Windows' [AppData directory](https://superuser.com/questions/632891/what-is-appdata). -```shell -# Jan's User Data directory -%AppData%\Jan +```bash +cd C:\Users\%USERNAME%\AppData\Roaming +rmdir /S jan ``` ## Troubleshooting diff --git a/docs/docs/guides/02-installation/03-linux.md b/docs/docs/guides/02-installation/03-linux.md index 7f0db2b78..4abde7be8 100644 --- a/docs/docs/guides/02-installation/03-linux.md +++ b/docs/docs/guides/02-installation/03-linux.md @@ -49,4 +49,4 @@ sudo apt-get remove jan # where jan is the name of Jan package ``` -In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at `$HOME/.config/Jan` and ~/.jan. This will return your system to its state prior to the installation of Jan. This method can also be used to reset all settings if you are experiencing any issues with Jan. +In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at ~/jan. This will return your system to its state prior to the installation of Jan. This method can also be used to reset all settings if you are experiencing any issues with Jan. diff --git a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx index 011b05480..527588092 100644 --- a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx +++ b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx @@ -32,7 +32,7 @@ The following steps will help you troubleshoot and resolve issues related to bro - To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). + To uninstall Jan on Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). @@ -53,15 +53,15 @@ The following steps will help you troubleshoot and resolve issues related to bro ```bash # Step 1: Delete the application data ## Newer versions - rm -rf /Users/$(whoami)/Library/Application\ Support/jan + rm -rf ~/Library/Application\ Support/jan ## Versions 0.2.0 and older - rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron + rm -rf ~/Library/Application\ Support/jan-electron # Step 2: Clear application cache - rm -rf /Users/$(whoami)/Library/Caches/jan* + rm -rf ~/Library/Caches/jan* # Step 3: Remove all user data - rm -rf ./jan + rm -rf ~/jan ``` @@ -70,16 +70,15 @@ The following steps will help you troubleshoot and resolve issues related to bro ```bash # You can delete the `/Jan` directory in Windows's AppData Directory by visiting the following path `%APPDATA%\Jan` cd C:\Users\%USERNAME%\AppData\Roaming - rm -rf ./Jan + rmdir /S jan ``` ```bash - # You can delete the user data folders located at the following `$HOME/.config/jan` and `~/.jan` - rm -r $HOME/.config/jan - rm -r ~/.jan + # You can delete the user data folders located at the following `~/jan` + rm -rf ~/jan ``` @@ -119,3 +118,4 @@ The following steps will help you troubleshoot and resolve issues related to bro 4. Download the latest version from via our homepage, [https://jan.ai/](https://jan.ai/). +> Note: If Jan is installed on multiple user accounts on your device, ensure it's completely removed from all shared space before reinstalling. \ No newline at end of file