Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: correct content on quickstart & installation

Browse Source
This commit is contained in:
Arista Indrajaya 2024-02-27 16:54:46 +07:00
parent 0dbccbd7ef
commit b7248bcf62
2 changed files with 15 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
docs/docs/quickstart/install.mdx
View File

@ -5,12 +5,12 @@ hide_table_of_contents: true
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
import installImageURL from '../../static/img/homepage-new/jan-ai-download.png'; import installImageURL from './assets/jan-ai-download.png';
# Installation # Installation
<Tabs> <Tabs>
<TabItem value="mac" label="Mac" default> <TabItem value="mac" label = "Mac" default>
:::warning :::warning
@ -34,46 +34,14 @@ Ensure that your MacOS version is 13 or higher to run Jan.
To enable the experimental mode, go to **Settings** > **Advanced Settings** and toggle the **Experimental Mode** To enable the experimental mode, go to **Settings** > **Advanced Settings** and toggle the **Experimental Mode**
### Uninstall for Troubleshooting :::warning
:::note If you are stuck in a broken build, go to the [Broken Build](/docs/common-error/broken-build) section of Common Errors.
If you are stuck in a broken build, try to uninstall Jan by following the steps below.
::: :::
To uninstall:
1. Delete Jan from your `/Applications` folder.
2. Delete Application data.
```sh
# Newer versions
rm -rf ~/Library/Application\ Support/jan
# Versions 0.2.0 and older
rm -rf ~/Library/Application\ Support/jan-electron
```
3. Clear Application cache.
```sh
rm -rf ~/Library/Caches/jan*
```
4. Use the following commands to remove any dangling backend processes:
```sh
ps aux | grep nitro
```
Look for processes like "nitro" and "nitro_arm_64", and kill them one by one with:
```sh
kill -9 <PID>
```
</TabItem> </TabItem>
<TabItem value="windows" label="Windows"> <TabItem value = "windows" label = "Windows">
:::warning :::warning
@ -111,25 +79,14 @@ To enable GPU support, you will need:
C:\Users\{username}\AppData\Local\Programs\Jan C:\Users\{username}\AppData\Local\Programs\Jan
``` ```
### Uninstall​ for Troubleshooting :::warning
:::note If you are stuck in a broken build, go to the [Broken Build](/docs/common-error/broken-build) section of Common Errors.
If you are stuck in a broken build, try to uninstall Jan by following the steps below.
::: :::
To uninstall Jan on Windows, uninstall it via [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).
```sh
cd C:\Users\%USERNAME%\AppData\Roaming
rmdir /S jan
```
</TabItem> </TabItem>
<TabItem value="linux" label="Linux"> <TabItem value = "linux" label = "Linux">
:::warning :::warning
Ensure that your system meets the following requirements: Ensure that your system meets the following requirements:
@ -157,13 +114,13 @@ To enable GPU support, you will need:
To enable the experimental mode, go to **Settings** > **Advanced Settings** and toggle the **Experimental Mode** To enable the experimental mode, go to **Settings** > **Advanced Settings** and toggle the **Experimental Mode**
<Tabs groupId="linux_type"> <Tabs groupId = "linux_type">
<TabItem value="linux_main" label="Linux"> <TabItem value="linux_main" label = "Linux">
To install Jan, you should use your package manager's install or `dpkg`. To install Jan, you should use your package manager's install or `dpkg`.
</TabItem> </TabItem>
<TabItem value="deb_ub" label="Debian / Ubuntu"> <TabItem value = "deb_ub" label = "Debian / Ubuntu">
To install Jan, run the following command: To install Jan, run the following command:
@ -177,7 +134,7 @@ To enable GPU support, you will need:
``` ```
</TabItem> </TabItem>
<TabItem value="other" label="Others"> <TabItem value = "other" label = "Others">
To install Jan, run the following commands: To install Jan, run the following commands:
@ -191,47 +148,10 @@ To enable GPU support, you will need:
</TabItem> </TabItem>
</Tabs> </Tabs>
### Uninstall​ for Troubleshooting :::warning
:::note If you are stuck in a broken build, go to the [Broken Build](/docs/common-error/broken-build) section of Common Errors.
If you are stuck in a broken build, try to uninstall Jan by following the steps below.
::: :::
<Tabs groupId="linux_type">
<TabItem value="linux_main" label="Linux">
To uninstall Jan, you should use your package manager's uninstall or remove option.
This will return your system to its state before the installation of Jan.
This method can also reset all settings if you are experiencing any issues with Jan.
</TabItem>
<TabItem value="deb_ub" label="Debian / Ubuntu">
To uninstall Jan, run the following command.MDXContent
```sh
sudo apt-get remove jan
# where jan is the name of Jan package
```
This will return your system to its state before the installation of Jan.
This method can also be used to reset all settings if you are experiencing any issues with Jan.
</TabItem>
<TabItem value="other" label="Others">
To uninstall Jan, you can uninstall Jan by deleting the `.AppImage` file.
If you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data at `~/jan`.
This method can also reset all settings if you are experiencing any issues with Jan.
</TabItem>
</Tabs>
</TabItem> </TabItem>
</Tabs> </Tabs>

2
docs/docs/quickstart/quickstart.mdx
View File

@ -3,7 +3,7 @@ sidebar_position: 1
hide_table_of_contents: true hide_table_of_contents: true
--- ---
import installImageURL from '../../static/img/homepage-new/jan-ai-quickstart.png'; import installImageURL from './assets/jan-ai-quickstart.png';
# Quickstart # Quickstart