diff --git a/docs/docs/developer/01-overview/README.md b/docs/docs/developer/01-overview/README.md index 70d74dc05..98e1b1164 100644 --- a/docs/docs/developer/01-overview/README.md +++ b/docs/docs/developer/01-overview/README.md @@ -18,7 +18,7 @@ keywords: The following docs are aimed at developers who want to build extensions on top of the Jan Framework. :::tip -If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastracture level support, please refer to [framework docs](/docs) instead. +If you are interested to **contribute to the framework's Core SDK itself**, like adding new drivers, runtimes, and infrastructure level support, please refer to [framework docs](/docs) instead. ::: ## Extensions diff --git a/docs/docs/guides/02-installation/01-mac.md b/docs/docs/guides/02-installation/01-mac.md index 1ef7638f7..8e67b5bed 100644 --- a/docs/docs/guides/02-installation/01-mac.md +++ b/docs/docs/guides/02-installation/01-mac.md @@ -30,7 +30,7 @@ jan-mac-x64-{version}.dmg jan-mac-arm64-{version}.dmg ``` -The typical installation process taks around a minute. +The typical installation process takes around a minute. ## GitHub Releases @@ -50,7 +50,7 @@ jan-mac-arm64-{version}.zip ## Uninstall Jan -As Jan is development mode, you might get stuck on a broken build. +As Jan is in development mode, you might get stuck on a broken build. To reset your installation 1. Delete Jan from your `/Applications` folder diff --git a/docs/docs/guides/02-installation/02-windows.md b/docs/docs/guides/02-installation/02-windows.md index e594e116a..b200554d2 100644 --- a/docs/docs/guides/02-installation/02-windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -64,7 +64,7 @@ rmdir /S jan ### Microsoft Defender -**Error: "Microsoft Defender Smartscreen prevented an unrecognized app from starting"** +**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. diff --git a/docs/docs/guides/02-installation/04-from-source.md b/docs/docs/guides/02-installation/04-from-source.md index e4ba9087f..06a025d1c 100644 --- a/docs/docs/guides/02-installation/04-from-source.md +++ b/docs/docs/guides/02-installation/04-from-source.md @@ -70,7 +70,7 @@ This will start the development server and open the desktop app. During this ste Build the app for macOS M1/M2 for production and place the result in the dist folder ```bash -# Do step 1 and 2 in previous section +# Do step 1 and 2 in the previous section git clone https://github.com/janhq/jan cd jan yarn install diff --git a/docs/docs/guides/02-installation/README.mdx b/docs/docs/guides/02-installation/README.mdx index 0721bb866..4c316c248 100644 --- a/docs/docs/guides/02-installation/README.mdx +++ b/docs/docs/guides/02-installation/README.mdx @@ -18,7 +18,7 @@ keywords: import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -In this quickstart we'll show you how to: +In this quickstart, we'll show you how to: - Download the Jan Desktop client - Mac, Windows, Linux, (and toaster) compatible - Download the Nightly (unstable) version diff --git a/docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx b/docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx index 37146209d..a3dee23c2 100644 --- a/docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx +++ b/docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx @@ -16,11 +16,11 @@ keywords: [ ] --- -You may receive a "Error Occured: Failed to Fetch" response when you first start chatting with a selected model. +You may receive an "Error occured: Failed to Fetch" response when you first start chatting with a selected model. This may occur due to several reasons. Please follow these steps to resolve it: -1. Ensure you are on the latest version of Mac, Windows or Ubuntu OS version +1. Ensure you are on the latest version of Mac, Windows, or Ubuntu OS version - Upgrading to the latest version has resolved this issue for most people diff --git a/docs/docs/handbook/onboarding.md b/docs/docs/handbook/onboarding.md index 3aec99258..969a1dc07 100644 --- a/docs/docs/handbook/onboarding.md +++ b/docs/docs/handbook/onboarding.md @@ -74,4 +74,4 @@ Welcome to Jan! We’re really excited to bring you onboard. - [ ] Github - 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. + - [ ] To make sure everyone in the remote working environment understands 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. diff --git a/docs/docs/handbook/product.md b/docs/docs/handbook/product.md index e8d114691..bd579b93b 100644 --- a/docs/docs/handbook/product.md +++ b/docs/docs/handbook/product.md @@ -33,7 +33,7 @@ We aim for a `loosely coupled, but tightly aligned` autonomous culture. - `Milestones` track release versions. We use [semantic versioning](https://semver.org/) - `Milestones` span ~2 weeks and have deadlines -- `Milestones` usually fit within 2 week sprint cycles +- `Milestones` usually fit within 2-week sprint cycles [`Tasks`](https://github.com/janhq/jan/issues) diff --git a/docs/docs/support/support.md b/docs/docs/support/support.md index 6f2b77548..5a1ec2097 100644 --- a/docs/docs/support/support.md +++ b/docs/docs/support/support.md @@ -1,6 +1,6 @@ # Support -- Bugs & requests: file a Github ticket [here](https://github.com/janhq/jan/issues) +- Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues) - For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH) - For business inquiries: email hello@jan.ai - For jobs: please email hr@jan.ai