Skip to content

Commit 20a5c79

Browse files
authored
Merge pull request #704 from janhq/docs/fix-error-messages
[docs] Update Docusaurus to 3.0 and fix closing tag issue in Handbook
2 parents f7f1e3d + 6110de4 commit 20a5c79

File tree

5 files changed

+2532
-1478
lines changed

5 files changed

+2532
-1478
lines changed

docs/docs/handbook/handbook.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Onboarding Checklist
33
slug: /handbook
44
---
55

6-
76
# Welcome
87

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

4746
### Apps you will need
4847

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

51-
</aside>
52+
:::
5253

5354
- Company-wide
5455
- [ ] Google:`[first_name]@jan.ai`
@@ -67,6 +68,3 @@ Welcome to Jan! We’re really excited to bring you onboard.
6768
- Communications
6869
- [ ] Fill in your contact details [here](https://docs.google.com/spreadsheets/d/1KAxya29_wb1bEESiFJeCrOec4pCG3uA2D4_VPgAn89U/edit#gid=0)
6970
- [ ] 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.
70-
71-
:::info UPDATING
72-
:::

docs/docs/install/windows.md

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,58 @@
22
title: Windows
33
---
44

5-
# Jan on Windows
5+
# Installing Jan on Windows
66

77
## Installation
8-
1. To download the lastest version of Jan on Windows, please visit the [Jan's homepage](https://jan.ai/).
9-
2. Once Jan installer (jan-win-x64-{version}.exe) is downloaded, run the installer. The installation process is expected to take around a minute.
10-
3. By default, Jan is installed under this directory
8+
9+
Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/).
10+
11+
For Windows, the download should be available as a `.exe` file in the following format.
12+
13+
```bash
14+
jan-win-x64-{version}.exe
15+
```
16+
17+
The typical installation process takes around a minute.
18+
19+
### Github Releases
20+
21+
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).
22+
23+
Within the Releases' assets, you will find the following files for Windows:
24+
25+
```bash
26+
# Windows Installers
27+
jan-win-x64-{version}.exe
28+
```
29+
30+
### Default Installation Directory
31+
32+
By default, Jan is installed in the following directory:
33+
1134
```bash
35+
# Default installation directory
1236
C:\Users\{username}\AppData\Local\Programs\Jan
1337
```
14-
## Uninstall Jan
15-
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.
16-
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.
1738

18-
## Common Questions
19-
### Microsoft Defender SmartScreen prevented an unrecognized app from starting
20-
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.
39+
## Uninstalling Jan
40+
41+
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).
42+
43+
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).
44+
45+
```shell
46+
# Jan's User Data directory
47+
%AppData%\Jan
48+
```
49+
50+
## Troubleshooting
51+
52+
### Microsoft Defender
53+
54+
**Error: "Microsoft Defender Smartscreen prevented an unrecognized app from starting"**
55+
56+
Windows Defender may display the above warning when running the Jan Installer, as a standard security measure.
57+
58+
To proceed, select the "More info" option and select the "Run Anyway" option to continue with the installation.
59+

docs/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^2.4.3",
18-
"@docusaurus/preset-classic": "^2.4.3",
19-
"@docusaurus/theme-live-codeblock": "^2.4.3",
20-
"@docusaurus/theme-mermaid": "^2.4.3",
17+
"@docusaurus/core": "^3.0.0",
18+
"@docusaurus/plugin-content-docs": "^3.0.0",
19+
"@docusaurus/preset-classic": "^3.0.0",
20+
"@docusaurus/theme-live-codeblock": "^3.0.0",
21+
"@docusaurus/theme-mermaid": "^3.0.0",
2122
"@headlessui/react": "^1.7.17",
2223
"@heroicons/react": "^2.0.18",
2324
"@mdx-js/react": "^1.6.22",
2425
"@redocly/cli": "^1.4.1",
2526
"autoprefixer": "^10.4.16",
2627
"axios": "^1.5.1",
2728
"clsx": "^1.2.1",
28-
"@docusaurus/plugin-content-docs": "2.4.3",
2929
"docusaurus-plugin-redoc": "^2.0.0",
3030
"docusaurus-plugin-sass": "^0.2.5",
3131
"docusaurus-theme-redoc": "^2.0.0",
@@ -41,7 +41,7 @@
4141
"tailwindcss": "^3.3.3"
4242
},
4343
"devDependencies": {
44-
"@docusaurus/module-type-aliases": "2.4.1",
44+
"@docusaurus/module-type-aliases": "^3.0.0",
4545
"dotenv": "^16.3.1",
4646
"tailwindcss-animate": "^1.0.7"
4747
},

docs/sidebars.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,15 @@ const sidebars = {
2525
{
2626
type: "category",
2727
label: "Installation",
28+
link: { type: "doc", id: "install/overview" },
2829
collapsible: true,
2930
collapsed: true,
30-
items: ["install/overview","install/windows", "install/mac", "install/linux", "install/from-source"],
31+
items: [
32+
"install/windows",
33+
"install/mac",
34+
"install/linux",
35+
"install/from-source",
36+
],
3137
},
3238
{
3339
type: "category",

0 commit comments

Comments
 (0)