From 698510b16c61497cfb32c9e2af94fc071178db86 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:32:41 +0900 Subject: [PATCH 1/9] docs: standardize commands --- docs/docs/guides/02-installation/01-mac.md | 6 +++--- docs/docs/guides/02-installation/03-linux.md | 2 +- .../07-troubleshooting/01-stuck-on-broken-build.mdx | 13 ++++++------- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md index ab8622164..d37f75548 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: 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..2b65dc440 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 @@ -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 ``` @@ -77,9 +77,8 @@ The following steps will help you troubleshoot and resolve issues related to bro ```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 ``` From 75064e7ef4de9814fc00487c8a0cab74f245475d Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 22 Dec 2023 23:02:51 +0900 Subject: [PATCH 2/9] docs: standardize commands --- docs/docs/guides/02-installation/02-windows.md | 3 ++- .../guides/07-troubleshooting/01-stuck-on-broken-build.mdx | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md index cfaee1f5b..7bf3cb0e9 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -57,7 +57,8 @@ To remove all user data associated with Jan, you can delete the `/Jan` directory ```shell # Jan's User Data directory -%AppData%\Jan +cd C:\Users\%USERNAME%\AppData\Roaming +rmdir /S Jan ``` ## Troubleshooting 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 2b65dc440..1eb60c7bd 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 @@ -70,7 +70,7 @@ 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 ``` From 251a77447fbfc03a741c9acc30d888a759b76b6d Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 22 Dec 2023 23:08:29 +0900 Subject: [PATCH 3/9] docs: fix typo in installation guide --- docs/docs/guides/02-installation/01-mac.md | 2 +- docs/docs/guides/02-installation/02-windows.md | 4 ++-- .../guides/07-troubleshooting/01-stuck-on-broken-build.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md index d37f75548..1ef7638f7 100644 --- a/docs/docs/guides/02-installation/01-mac.md +++ b/docs/docs/guides/02-installation/01-mac.md @@ -76,7 +76,7 @@ rm -rf ~/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 7bf3cb0e9..388360adf 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -53,12 +53,12 @@ C:\Users\{username}\AppData\Local\Programs\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 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 cd C:\Users\%USERNAME%\AppData\Roaming -rmdir /S Jan +rmdir /S jan ``` ## Troubleshooting 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 1eb60c7bd..723a16bd5 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 @@ -70,7 +70,7 @@ 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 - rmdir /S Jan + rmdir /S jan ``` From 534070c4cf289c7a5292be5ada373fed5fed23f6 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sat, 23 Dec 2023 00:41:43 +0900 Subject: [PATCH 4/9] docs: remove unnec part --- docs/docs/guides/02-installation/02-windows.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md index 388360adf..75bbe230a 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -55,8 +55,7 @@ To uninstall Jan in Windows, use the [Windows Control Panel](https://support.mic 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 +```bash cd C:\Users\%USERNAME%\AppData\Roaming rmdir /S jan ``` From ba2c1e3f032a5ad7c222906afe26fe4605efd888 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 01:12:26 +0900 Subject: [PATCH 5/9] docs: add addtional note --- docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx | 1 + 1 file changed, 1 insertion(+) 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 723a16bd5..d88f5a93a 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 @@ -118,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 accounts before reinstalling. \ No newline at end of file From 378a0e2f4c68373228d7c9a00e7bd2706a1e23fc Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 12:49:37 +0900 Subject: [PATCH 6/9] docs: update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 116d66543..17dd8f4f8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,34 @@ --- 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: '' --- -**Describe the bug** +**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 '....' 3. Scroll down to '....' -4. See error +4. Observe the error -**Expected behavior** +**Expected 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. +**Additional Context** +Add any other context or information that could be helpful in diagnosing the problem. From 0465483a3941e279cdb9a33fec6c3302f5b5107e Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 12:53:38 +0900 Subject: [PATCH 7/9] docs: fix typo --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 17dd8f4f8..0ba8b6669 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,28 +7,28 @@ assignees: '' --- -**Describe the Bug** +**Describe the bug** A clear and concise description of what the bug is. -**Steps to Reproduce** +**Steps to reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' -4. Observe the error +4. See error -**Expected Behavior** +**Expected behavior** A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your issue. -**Environment Details** +**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** +**Additional context** Add any other context or information that could be helpful in diagnosing the problem. From 2ba5fca70bda487b25a8cd527e6ddc0a2192a2b3 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 15:58:44 +0900 Subject: [PATCH 8/9] docs: fix typo --- docs/docs/guides/02-installation/02-windows.md | 2 +- .../docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md index 75bbe230a..e594e116a 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -51,7 +51,7 @@ 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). 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 d88f5a93a..42088b934 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). From 804d57288b1ff64ae8c90b6b1aad766bd90c4ab6 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Mon, 25 Dec 2023 16:03:52 +0900 Subject: [PATCH 9/9] docs: update clear note --- .../docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 42088b934..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 @@ -118,4 +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 accounts before reinstalling. \ No newline at end of file +> 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