Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update Jan Docs #4362

Open
wants to merge 17 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/src/pages/docs/_assets/instructions.gif
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/pages/docs/_assets/model-management1.png
Binary file not shown.
Binary file removed docs/src/pages/docs/_assets/model-management2.png
Binary file not shown.
Binary file modified docs/src/pages/docs/_assets/model-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/quick-start-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/quick-start-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/quick-start-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/threads-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/threads-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/threads-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/threads-04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/pages/docs/_assets/threads-05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/pages/docs/_assets/title.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/src/pages/docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"quickstart": {
"title": "Quickstart"
},
"desktop": "Desktop",
"desktop": "Installation",
"data-folder": "Jan Data Folder",
"privacy": "Privacy",
"user-guides": {
Expand Down Expand Up @@ -41,5 +41,9 @@
"type": "separator"
},
"troubleshooting": "Troubleshooting",
"error-codes": "Error Codes"
"error-codes": {
"type": "page",
"display": "hidden",
"title": "Error Codes"
}
}
31 changes: 11 additions & 20 deletions docs/src/pages/docs/data-folder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,24 @@ Jan stores your data locally in your own filesystem in a universal file format (

This guide helps you understand where and how this data is stored.

## Open the Data Folder
## Open Jan Data Folder

To open the Jan data folder from the app:
1. Click the System monitor button on your Jan app.
2. Click the App Log button.
3. This redirects you to the Jan data folder.
To open from Jan's interface:
1. In Jan, navigate to **Settings** > **Advanced Settings**
2. Open **Jan Data Folder**

To open through Terminal:

```bash
# Windows
~/AppData/Roaming/Jan/data
%APPDATA%/Jan/data

# Mac
~/Library/Application\ Support/Jan/data
~/Library/Application Support/Jan/data

# Linux
## Custom installation directory
$XDG_CONFIG_HOME = /home/username/custom_config
$XDG_CONFIG_HOME/Jan/data

or

Expand Down Expand Up @@ -233,18 +234,8 @@ Threads history is kept in this directory. Each session or thread is stored in a
| `model` | The selected model and its settings/parameters for the thread. Changes made by users to thread settings are written here, rather than in model.json. Also contains the ID and engine of the selected model for quick querying by extensions. |
| `metadata` | Additional thread data, such as `lastMessage`, which provides GUI information but does not use OpenAI-compatible fields. |

## Open the Data Folder

To open the Jan data folder, follow the steps in the [Settings](/docs/settings#access-the-jan-data-folder) guide.

## Delete Jan Data Folder

If you have uninstalled the Jan app, you may also want to delete the Jan data folder. You can automatically remove this folder during uninstallation by selecting **OK** when prompted.

![Delete Data Folder](./_assets/delete-data.png)

If you missed this step and need to delete the folder manually, please follow these instructions:

1. Go to the root data folder in your Users directory.
2. Locate the Jan data folder.
3. Delete the folder manually.
If you have uninstalled Jan, you may also want to delete the Jan data folder.
See detail instructions on [Mac](/docs/desktop/mac#step-2-clean-up-data-optional), [Window](/docs/desktop/windows#step-2-handle-jan-data), [Linux](docs/desktop/linux#uninstall-jan).
4 changes: 2 additions & 2 deletions docs/src/pages/docs/desktop.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Desktop Installation
title: Installation
description: Jan is a ChatGPT-alternative that runs on your computer, with a local API server.
keywords:
[
Expand All @@ -20,7 +20,7 @@ keywords:
import { Cards, Card } from 'nextra/components'
import childPages from './desktop/_meta.json';

# Desktop Installation
# Installation

<br/>

Expand Down
Loading
Loading