diff --git a/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx b/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
index ef418ff97..6c208764d 100644
--- a/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
+++ b/docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
@@ -5,6 +5,21 @@ slug: /postmortems/january-10-2024-bitdefender-false-positive-flag
tags: [Postmortem]
---
+
+ Jan 10, 2024 Incident Postmortem - Bitdefender False Positive Flag on Jan AI Resolved
+
+
+
+
+
+
+
+
+
+
+
+
+
Following the recent incident related to Jan version 0.4.4 triggering Bitdefender on Windows with Gen:Variant.Tedy.258323 on January 10, 2024, we wanted to provide a comprehensive postmortem and outline the necessary follow-up actions.
## Incident Overview
diff --git a/docs/docs/developer/01-overview/01-architecture.md b/docs/docs/developer/01-overview/01-architecture.md
index 432b12537..218964bed 100644
--- a/docs/docs/developer/01-overview/01-architecture.md
+++ b/docs/docs/developer/01-overview/01-architecture.md
@@ -15,6 +15,20 @@ keywords:
]
---
+
+ Jan AI Architecture - Modular and Extensible Framework
+
+
+
+
+
+
+
+
+
+
+
+
:::warning
This page is still under construction, and should be read as a scratchpad
diff --git a/docs/docs/developer/01-overview/02-file-based.md b/docs/docs/developer/01-overview/02-file-based.md
index 653eba3f5..2cd8a554c 100644
--- a/docs/docs/developer/01-overview/02-file-based.md
+++ b/docs/docs/developer/01-overview/02-file-based.md
@@ -15,6 +15,20 @@ keywords:
]
---
+
+ Jan AI File-based Data Persistence Approach
+
+
+
+
+
+
+
+
+
+
+
+
:::warning
This page is still under construction, and should be read as a scratchpad
diff --git a/docs/docs/developer/01-overview/03-user-interface.md b/docs/docs/developer/01-overview/03-user-interface.md
index eb6eac89e..fa5a3de79 100644
--- a/docs/docs/developer/01-overview/03-user-interface.md
+++ b/docs/docs/developer/01-overview/03-user-interface.md
@@ -15,6 +15,20 @@ keywords:
]
---
+
+ Jan AI User Interface - Customizable UI Kit
+
+
+
+
+
+
+
+
+
+
+
+
:::warning
This page is still under construction, and should be read as a scratchpad
diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
index 9752f7b72..a3e6ccfc1 100644
--- a/docs/docs/developer/01-overview/04-install-and-prerequisites.md
+++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md
@@ -18,6 +18,20 @@ keywords:
]
---
+
+ Jan AI Installation and Setup Guide - Developer Prerequisites
+
+
+
+
+
+
+
+
+
+
+
+
## Requirements
### Hardware Requirements
diff --git a/docs/docs/developer/01-overview/README.md b/docs/docs/developer/01-overview/README.md
index 7bc3524de..4f094685a 100644
--- a/docs/docs/developer/01-overview/README.md
+++ b/docs/docs/developer/01-overview/README.md
@@ -15,6 +15,20 @@ keywords:
]
---
+
+ Jan AI Developer Documentation - Building Extensions and SDK Overview
+
+
+
+
+
+
+
+
+
+
+
+
The following docs are aimed at developers who want to build extensions on top of the Jan Framework.
:::tip
diff --git a/docs/docs/developer/04-build-extension/01-your-first-extension.md b/docs/docs/developer/04-build-extension/01-your-first-extension.md
index f89f34053..3fa9f5da5 100644
--- a/docs/docs/developer/04-build-extension/01-your-first-extension.md
+++ b/docs/docs/developer/04-build-extension/01-your-first-extension.md
@@ -17,6 +17,20 @@ keywords:
]
---
+
+ Building Your First Jan AI Extension - Quick Start Guide
+
+
+
+
+
+
+
+
+
+
+
+
:::caution
This is currently under development.
:::
@@ -76,13 +90,13 @@ There are a few things to keep in mind when writing your extension code:
In `index.ts`, you will see that the extension function will return a `Promise`.
```typescript
- import { core } from "@janhq/core";
+ import { core } from '@janhq/core'
function onStart(): Promise {
- return core.invokePluginFunc(MODULE_PATH, "run", 0);
+ return core.invokePluginFunc(MODULE_PATH, 'run', 0)
}
```
For more information about the Jan Extension Core module, see the [documentation](https://github.com/janhq/jan/blob/main/core/README.md).
-Now, go ahead and start customizing your extension! Happy coding!
\ No newline at end of file
+Now, go ahead and start customizing your extension! Happy coding!
diff --git a/docs/docs/guides/error-codes/permission-denied.mdx b/docs/docs/guides/error-codes/permission-denied.mdx
index 1d41d3b03..a1c3577f9 100644
--- a/docs/docs/guides/error-codes/permission-denied.mdx
+++ b/docs/docs/guides/error-codes/permission-denied.mdx
@@ -17,7 +17,21 @@ keywords:
]
---
-When running Jan, you might encounter the following error message:
+
+ Resolving "Permission Denied" Error in Jan AI
+
+
+
+
+
+
+
+
+
+
+
+
+When you run Jan, you may encounter the following error:
```
Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension':
diff --git a/docs/docs/guides/extensions/setup-ext.mdx b/docs/docs/guides/extensions/setup-ext.mdx
index c080283e9..b8e1f757d 100644
--- a/docs/docs/guides/extensions/setup-ext.mdx
+++ b/docs/docs/guides/extensions/setup-ext.mdx
@@ -16,6 +16,19 @@ keywords:
]
---
+
+ Configuring Extension Settings in Jan AI - User Guide
+
+
+
+
+
+
+
+
+
+
+
The current Jan Desktop Client has some default extensions built on top of this framework to enhance the user experience. In this guide, we will show you the list of default extensions and how to configure extension settings.
diff --git a/docs/docs/hardware/community.md b/docs/docs/hardware/community.md
index e1825b24b..5ba920d89 100644
--- a/docs/docs/hardware/community.md
+++ b/docs/docs/hardware/community.md
@@ -1,12 +1,36 @@
---
title: Hardware Examples
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
-keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ]
+keywords:
+ [
+ Jan AI,
+ Jan,
+ ChatGPT alternative,
+ local AI,
+ private AI,
+ conversational AI,
+ no-subscription fee,
+ large language model,
+ ]
---
+
+ Hardware Examples
+
+
+
+
+
+
+
+
+
+
+
+
## Add your own example
-Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
+Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
```shell
docs
@@ -18,9 +42,10 @@ docs
// highlight-next-line
└── .md
```
+
### File and Title Convention
-We use a specific naming convention for the file name.
+We use a specific naming convention for the file name.
```shell
# Filename
@@ -52,4 +77,4 @@ You are allowed to include affiliate links in your example.
## Longer-Term
-We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.
\ No newline at end of file
+We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.
diff --git a/docs/docs/hardware/concepts/gpu-and-vram.md b/docs/docs/hardware/concepts/gpu-and-vram.md
index 57387e8d2..0a9316a90 100644
--- a/docs/docs/hardware/concepts/gpu-and-vram.md
+++ b/docs/docs/hardware/concepts/gpu-and-vram.md
@@ -2,6 +2,20 @@
title: GPUs and VRAM
---
+
+ Understanding GPUs and VRAM for AI and Gaming
+
+
+
+
+
+
+
+
+
+
+
+
## What Is a GPU?
A Graphics Card, or GPU (Graphics Processing Unit), is a fundamental component in modern computing. Think of it as the powerhouse behind rendering the stunning visuals you see on your screen. Similar to the motherboard in your computer, the graphics card is a printed circuit board. However, it's not just a passive piece of hardware; it's a sophisticated device equipped with essential components like fans, onboard RAM, a dedicated memory controller, BIOS, and various other features. If you want to learn more about GPUs then read here to [Understand the architecture of a GPU.](https://medium.com/codex/understanding-the-architecture-of-a-gpu-d5d2d2e8978b)
diff --git a/docs/docs/hardware/recommendations/by-budget.md b/docs/docs/hardware/recommendations/by-budget.md
index 9e640fbc9..e556c77d3 100644
--- a/docs/docs/hardware/recommendations/by-budget.md
+++ b/docs/docs/hardware/recommendations/by-budget.md
@@ -2,6 +2,20 @@
title: Recommended AI Hardware by Budget
---
+
+ Recommended AI Hardware Builds by Budget
+
+
+
+
+
+
+
+
+
+
+
+
> :warning: **Warning:** Do your own research before any purchase. Jan is not liable for compatibility, performance or other issues. Products can become outdated quickly.
## Entry-level PC Build at $1000
diff --git a/docs/docs/hardware/recommendations/by-hardware.md b/docs/docs/hardware/recommendations/by-hardware.md
index ee80a290c..dcd744d8b 100644
--- a/docs/docs/hardware/recommendations/by-hardware.md
+++ b/docs/docs/hardware/recommendations/by-hardware.md
@@ -2,6 +2,20 @@
title: Selecting AI Hardware
---
+
+ Selecting AI Hardware
+
+
+
+
+
+
+
+
+
+
+
+
When selecting a GPU for LLMs, remember that it's not just about the GPU itself. Consider the synergy with other components in your PC:
- **CPU**: To ensure efficient processing, pair your GPU with a powerful CPU. LLMs benefit from fast processors, so having a capable CPU is essential.
diff --git a/docs/docs/hardware/recommendations/by-model.md b/docs/docs/hardware/recommendations/by-model.md
index 99d1ca8a2..e9fe1c3e8 100644
--- a/docs/docs/hardware/recommendations/by-model.md
+++ b/docs/docs/hardware/recommendations/by-model.md
@@ -2,6 +2,20 @@
title: Recommended AI Hardware by Model
---
+
+ Recommended AI Hardware by Model
+
+
+
+
+
+
+
+
+
+
+
+
## Codellama 34b
### System Requirements:
diff --git a/docs/docs/hardware/recommendations/by-usecase.md b/docs/docs/hardware/recommendations/by-usecase.md
index 2ae0cb906..aa7a1bf75 100644
--- a/docs/docs/hardware/recommendations/by-usecase.md
+++ b/docs/docs/hardware/recommendations/by-usecase.md
@@ -2,6 +2,20 @@
title: Recommended AI Hardware by Use Case
---
+
+ Recommended AI Hardware by Model
+
+
+
+
+
+
+
+
+
+
+
+
## Which AI Hardware to Choose Based on Your Use Case
Artificial intelligence (AI) is rapidly changing the world, and AI hardware is becoming increasingly important for businesses and individuals alike. Choosing the right hardware for your AI needs is crucial to get the best performance and results. Here are some tips for selecting AI hardware based on your specific use case and requirements.
diff --git a/docs/docs/privacy/privacy.md b/docs/docs/privacy/privacy.md
index 56e81f3a1..e1f5d0f10 100644
--- a/docs/docs/privacy/privacy.md
+++ b/docs/docs/privacy/privacy.md
@@ -1,3 +1,21 @@
+---
+title: Privacy - Jan
+---
+
+
+ Privacy Policy - Jan
+
+
+
+
+
+
+
+
+
+
+
+
# Privacy Policy
Jan is committed to protecting your privacy and ensuring that your personal information is handled in a safe and responsible way. This policy outlines how we collect, store, and use your personal information when you use our mobile application.
diff --git a/docs/docs/support/support.md b/docs/docs/support/support.md
index 5a1ec2097..856041f86 100644
--- a/docs/docs/support/support.md
+++ b/docs/docs/support/support.md
@@ -1,3 +1,21 @@
+---
+title: Support - Jan
+---
+
+
+ Support - Jan
+
+
+
+
+
+
+
+
+
+
+
+
# Support
- Bugs & requests: file a GitHub ticket [here](https://github.com/janhq/jan/issues)
diff --git a/docs/docs/template/QA_script.md b/docs/docs/template/QA_script.md
index 9c7eeaf18..d0ba4b90f 100644
--- a/docs/docs/template/QA_script.md
+++ b/docs/docs/template/QA_script.md
@@ -1,5 +1,25 @@
+---
+title: Jan version release template
+---
+
+
+ Release Version QA Script template
+
+
+
+
+
+
+
+
+
+
+
+
# Regression test
+# [Release Version] QA Script
+
**Release Version:** v0.4.7
**Operating System:** MacOS
@@ -26,7 +46,6 @@
- [ ] :key::warning: Check that the uninstallation process removes the app successfully from the system.
- [ ] Clean the Jan root directory and open the app to check if it creates all the necessary folders, especially models and extensions.
-
## B. Overview
### 1. Shortcut key, memory usage / CPU usage
@@ -71,10 +90,18 @@
- [ ] :key: Ensure that users switch between threads with different models, the app can handle it.
### 3. Model dropdown
+
- [ ] :key: Model list should highlight recommended based on user RAM
- [ ] Model size should display (for both installed and imported models)
### 4. Users can click on a history thread
+
+# <<<<<<< HEAD
+
+- [ ] Test the ability to click on any thread in the history panel.
+- [ ] :key: Verify that clicking a thread brings up the past conversation in the main chat window.
+- [ ] :key: Ensure that the selected thread is highlighted or otherwise indicated in the history panel.
+ > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Confirm that the chat window displays the entire conversation from the selected history thread without any missing messages.
- [ ] :key: Check the performance and accuracy of the history feature when dealing with a large number of threads.
- [ ] Validate that historical threads reflect the exact state of the chat at that time, including settings.
@@ -82,12 +109,16 @@
- [ ] Confirm that changing the title of the thread updates correctly.
### 5. Users can config instructions for the assistant.
+
+# <<<<<<< HEAD
+
+- [ ] Ensure there is a clear interface to input or change instructions for the assistant.
+ > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Test if the instructions set by the user are being followed by the assistant in subsequent conversations.
- [ ] :key: Validate that changes to instructions are updated in real time and do not require a restart of the application or session.
- [ ] :key: Check for the ability to reset instructions to default or clear them completely.
- [ ] :key: RAG - Users can import documents and the system should process queries about the uploaded file, providing accurate and appropriate responses in the conversation thread.
-
## D. Hub
### 1. Users can discover recommended models (Jan ships with a few preconfigured model.json files)
@@ -117,13 +148,14 @@
### 5. Users can use the model as they want
-- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does.
+- [ ] :key: Check `start` / `stop` / `delete` button response exactly what it does.
- [ ] Check if starting another model stops the other model entirely.
- [x] :rocket: Check the `Explore models` navigate correctly to the model panel.
- [ ] :key: Check when deleting a model it will delete all the files on the user's computer.
- [ ] :warning:The recommended tags should present right for the user's hardware.
### 6. Users can Integrate With a Remote Server
+
- [ ] :key: Import openAI GPT model https://jan.ai/guides/using-models/integrate-with-remote-server/ and the model displayed in Hub / Thread dropdown
- [ ] Users can use the remote model properly
@@ -175,6 +207,27 @@
- [ ] :key: Test the `Experimental Mode` toggle to confirm it enables or disables experimental features as intended.
- [ ] :key: Check the functionality of `Open App Directory` to ensure it opens the correct folder in the system file explorer.
+ <<<<<<< HEAD
+ =======
+- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed.
+- [ ] Test the application's stability when experimental features are enabled.
+
+### 4. Users can add custom plugins via manual installation [TBU]
+
+- [ ] Verify that the `Manual Installation` option is clearly visible and accessible in the `Extensions` section.
+- [ ] Test the functionality of the `Select` button within the `Manual Installation` area.
+- [ ] :warning: Check that the file picker dialog allows for the correct plugin file types (e.g., .tgz).
+- [ ] :key: Validate that the selected plugin file installs correctly and the plugin becomes functional.
+- [ ] Ensure that there is a progress indicator or confirmation message once the installation is complete.
+- [ ] Confirm that if the installation is interrupted or fails, the user is given a clear error message.
+- [ ] :key: Test that the application prevents the installation of incompatible or corrupt plugin files.
+- [ ] :key: Check that the user can uninstall or disable custom plugins as easily as pre-installed ones.
+- [ ] Verify that the application's performance remains stable after the installation of custom plugins.
+
+### 5. Advanced Settings
+
+- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562)
+ > > > > > > > f2847d56c (feat: Add SEO header tag with OpenAI GPT-4)
- [ ] Users can move **Jan data folder**
- [ ] Validate that changes in advanced settings are applied immediately or provide appropriate instructions if a restart is needed.
- [ ] Attemp to test downloading model from hub using **HTTP Proxy** [guideline](https://github.com/janhq/jan/pull/1562)
@@ -184,9 +237,10 @@
## G. Local API server
### 1. Local Server Usage with Server Options
+
- [ ] :key: Explore API Reference: Swagger API for sending/receiving requests
- - [ ] Use default server option
- - [ ] Configure and use custom server options
+ - [ ] Use default server option
+ - [ ] Configure and use custom server options
- [ ] Test starting/stopping the local API server with different Model/Model settings
- [ ] Server logs captured with correct Server Options provided
- [ ] Verify functionality of Open logs/Clear feature