Skip to content

Commit

Permalink
Merge pull request janhq#704 from janhq/docs/fix-error-messages
Browse files Browse the repository at this point in the history
[docs] Update Docusaurus to 3.0 and fix closing tag issue in Handbook
  • Loading branch information
dan-menlo authored Nov 23, 2023
2 parents f7f1e3d + 6110de4 commit 20a5c79
Show file tree
Hide file tree
Showing 5 changed files with 2,532 additions and 1,478 deletions.
10 changes: 4 additions & 6 deletions docs/docs/handbook/handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Onboarding Checklist
slug: /handbook
---


# Welcome

Welcome to Jan! We’re really excited to bring you onboard.
Expand Down Expand Up @@ -46,9 +45,11 @@ Welcome to Jan! We’re really excited to bring you onboard.

### Apps you will need

<aside> 💡 In order to feel connected in a remote workplace, we encourage you to add your profile photo to all the accounts.
:::info

💡 In order to feel connected in a remote workplace, we encourage you to add your profile photo to all the accounts.

</aside>
:::

- Company-wide
- [ ] Google:`[first_name]@jan.ai`
Expand All @@ -67,6 +68,3 @@ Welcome to Jan! We’re really excited to bring you onboard.
- Communications
- [ ] Fill in your contact details [here](https://docs.google.com/spreadsheets/d/1KAxya29_wb1bEESiFJeCrOec4pCG3uA2D4_VPgAn89U/edit#gid=0)
- [ ] To make sure everyone in the remote working environment understand more about each other, we encourage you to share your `How to work with me` in the [Drive Tab](https://docs.google.com/spreadsheets/d/1KAxya29_wb1bEESiFJeCrOec4pCG3uA2D4_VPgAn89U/edit#gid=0) under your name and the Discord `Internal` channel.

:::info UPDATING
:::
59 changes: 49 additions & 10 deletions docs/docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,58 @@
title: Windows
---

# Jan on Windows
# Installing Jan on Windows

## Installation
1. To download the lastest version of Jan on Windows, please visit the [Jan's homepage](https://jan.ai/).
2. Once Jan installer (jan-win-x64-{version}.exe) is downloaded, run the installer. The installation process is expected to take around a minute.
3. By default, Jan is installed under this directory

Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/).

For Windows, the download should be available as a `.exe` file in the following format.

```bash
jan-win-x64-{version}.exe
```

The typical installation process takes around a minute.

### Github Releases

Jan is also available from [Jan's Github Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest).

Within the Releases' assets, you will find the following files for Windows:

```bash
# Windows Installers
jan-win-x64-{version}.exe
```

### Default Installation Directory

By default, Jan is installed in the following directory:

```bash
# Default installation directory
C:\Users\{username}\AppData\Local\Programs\Jan
```
## Uninstall Jan
If you have installed Jan on your Windows computer, either as a User or System installation, you can easily uninstall it by going to the Windows Control Panel.
In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at `%APPDATA%\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.

## Common Questions
### Microsoft Defender SmartScreen prevented an unrecognized app from starting
When initiating the Jan Installer, be aware that Windows Defender may display a warning. This warning is a standard security measure, as the installer will make changes to the system. To proceed with the installation, navigate through the warning options, typically found in "More info" section and select the appropriate option to continue with the installation.
## 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 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
```

## Troubleshooting

### Microsoft Defender

**Error: "Microsoft Defender Smartscreen prevented an unrecognized app from starting"**

Windows Defender may display the above warning when running the Jan Installer, as a standard security measure.

To proceed, select the "More info" option and select the "Run Anyway" option to continue with the installation.

12 changes: 6 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^2.4.3",
"@docusaurus/preset-classic": "^2.4.3",
"@docusaurus/theme-live-codeblock": "^2.4.3",
"@docusaurus/theme-mermaid": "^2.4.3",
"@docusaurus/core": "^3.0.0",
"@docusaurus/plugin-content-docs": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@docusaurus/theme-live-codeblock": "^3.0.0",
"@docusaurus/theme-mermaid": "^3.0.0",
"@headlessui/react": "^1.7.17",
"@heroicons/react": "^2.0.18",
"@mdx-js/react": "^1.6.22",
"@redocly/cli": "^1.4.1",
"autoprefixer": "^10.4.16",
"axios": "^1.5.1",
"clsx": "^1.2.1",
"@docusaurus/plugin-content-docs": "2.4.3",
"docusaurus-plugin-redoc": "^2.0.0",
"docusaurus-plugin-sass": "^0.2.5",
"docusaurus-theme-redoc": "^2.0.0",
Expand All @@ -41,7 +41,7 @@
"tailwindcss": "^3.3.3"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1",
"@docusaurus/module-type-aliases": "^3.0.0",
"dotenv": "^16.3.1",
"tailwindcss-animate": "^1.0.7"
},
Expand Down
8 changes: 7 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,15 @@ const sidebars = {
{
type: "category",
label: "Installation",
link: { type: "doc", id: "install/overview" },
collapsible: true,
collapsed: true,
items: ["install/overview","install/windows", "install/mac", "install/linux", "install/from-source"],
items: [
"install/windows",
"install/mac",
"install/linux",
"install/from-source",
],
},
{
type: "category",
Expand Down
Loading

0 comments on commit 20a5c79

Please sign in to comment.