Skip to content

Commit

Permalink
feat: Add SEO header tag with OpenAI GPT-4
Browse files Browse the repository at this point in the history
  • Loading branch information
@hiro-v
hiro-v committed Mar 19, 2024
1 parent d1a17f0 commit 4a267ff
Show file tree
Hide file tree
Showing 18 changed files with 324 additions and 13 deletions.
15 changes: 15 additions & 0 deletions docs/blog/01-january-10-2024-bitdefender-false-positive-flag.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ slug: /postmortems/january-10-2024-bitdefender-false-positive-flag
tags: [Postmortem]
---

<head>
<title>Jan 10, 2024 Incident Postmortem - Bitdefender False Positive Flag on Jan AI Resolved</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, postmortem, incident, flagging issue" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:title" content="Bitdefender False Positive Flag on Jan AI Resolved - Jan 10, 2024 Incident Postmortem" />
<meta property="og:description" content="Comprehensive postmortem on the Jan AI v0.4.4 Bitdefender false positive incident on January 10, 2024. Learn about the investigation, solutions, and preventive measures." />
<meta property="og:url" content="https://jan.ai/blog/postmortems/january-10-2024-bitdefender-false-positive-flag/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>


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
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/developer/01-overview/01-architecture.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ keywords:
]
---

<head>
<title>Jan AI Architecture - Modular and Extensible Framework</title>
<meta charSet="utf-8" />
<meta name="description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, modular architecture, Extensions API" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/architecture/" />
<meta property="og:title" content="Jan AI Architecture - Modular and Extensible Framework" />
<meta property="og:description" content="Discover the modular architecture of Jan, a ChatGPT alternative that runs on your own computer. Learn about Jan's local API server, Desktop UI, and the Nitro inference engine." />
<meta property="og:url" content="https://jan.ai/developer/architecture/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

:::warning

This page is still under construction, and should be read as a scratchpad
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/developer/01-overview/02-file-based.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ keywords:
]
---

<head>
<title>Jan AI File-based Data Persistence Approach</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, file-based data storage, data persistence" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/file-based/" />
<meta property="og:title" content="Jan AI File-based Data Persistence Approach" />
<meta property="og:description" content="Learn how Jan, a ChatGPT alternative, leverages a local filesystem for data persistence, promoting composability and tinkerability similar to VSCode." />
<meta property="og:url" content="https://jan.ai/developer/file-based/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

:::warning

This page is still under construction, and should be read as a scratchpad
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/developer/01-overview/03-user-interface.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ keywords:
]
---

<head>
<title>Jan AI User Interface - Customizable UI Kit</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, UI Kit, customizable UI" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/ui/" />
<meta property="og:title" content="Jan AI User Interface - Customizable UI Kit" />
<meta property="og:description" content="Explore Jan's UI Kit for customizing the user interface to fit your brand and style. Learn how to personalize your application with Jan's flexible UI components." />
<meta property="og:url" content="https://jan.ai/developer/ui/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

:::warning

This page is still under construction, and should be read as a scratchpad
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/developer/01-overview/04-install-and-prerequisites.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ keywords:
]
---

<head>
<title>Jan AI Installation and Setup Guide - Developer Prerequisites</title>
<meta charSet="utf-8" />
<meta name="description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, installation, prerequisites, developer setup" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/prereq/" />
<meta property="og:title" content="Jan AI Installation and Setup Guide - Developer Prerequisites" />
<meta property="og:description" content="Comprehensive guide to installing and setting up Jan for development. Covers hardware, system requirements, and step-by-step instructions for developers." />
<meta property="og:url" content="https://jan.ai/developer/prereq/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

## Requirements

### Hardware Requirements
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/developer/01-overview/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ keywords:
]
---

<head>
<title>Jan AI Developer Documentation - Building Extensions and SDK Overview</title>
<meta charSet="utf-8" />
<meta name="description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extensible framework, SDK, building extensions" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/" />
<meta property="og:title" content="Jan AI Developer Documentation - Building Extensions and SDK Overview" />
<meta property="og:description" content="Guide for developers on building extensions on top of the Jan Framework. Learn about Jan's extensible framework for AI applications, available on all platforms." />
<meta property="og:url" content="https://jan.ai/developer/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

The following docs are aimed at developers who want to build extensions on top of the Jan Framework.

:::tip
Expand Down
20 changes: 17 additions & 3 deletions docs/docs/developer/04-build-extension/01-your-first-extension.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ keywords:
]
---

<head>
<title>Building Your First Jan AI Extension - Quick Start Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, quick start, build extension" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:title" content="Building Your First Jan AI Extension - Quick Start Guide" />
<meta property="og:description" content="Step-by-step guide on how to build your first extension for Jan AI. Learn how to use the extension template and integrate your custom functionality into Jan." />
<meta property="og:url" content="https://jan.ai/developer/build-extension/your-first-extension/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

:::caution
This is currently under development.
:::
Expand Down Expand Up @@ -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<any>`.

```typescript
import { core } from "@janhq/core";
import { core } from '@janhq/core'

function onStart(): Promise<any> {
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!
Now, go ahead and start customizing your extension! Happy coding!
16 changes: 15 additions & 1 deletion docs/docs/guides/error-codes/permission-denied.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,21 @@ keywords:
]
---

When running Jan, you might encounter the following error message:
<head>
<title>Resolving "Permission Denied" Error in Jan AI</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, troubleshooting, permission denied" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:title" content="Resolving 'Permission Denied' Error in Jan AI" />
<meta property="og:description" content="Learn how to resolve the 'Permission Denied' error encountered while running Jan AI by changing ownership of the `~/.npm` directory to the current user." />
<meta property="og:url" content="https://jan.ai/troubleshooting/permission-denied" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

When you run Jan, you may encounter the following error:

```
Uncaught (in promise) Error: Error invoking layout-480796bff433a3a3.js:538 remote method 'installExtension':
Expand Down
13 changes: 13 additions & 0 deletions docs/docs/guides/extensions/setup-ext.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ keywords:
]
---

<head>
<title>Configuring Extension Settings in Jan AI - User Guide</title>
<meta charSet="utf-8" />
<meta name="description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, extension settings" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:title" content="Configuring Extension Settings in Jan AI - User Guide" />
<meta property="og:description" content="Learn how to configure settings for default extensions in Jan AI, including how to enable/disable extensions and modify their configurations." />
<meta property="og:url" content="https://jan.ai/guides/using-extensions/extension-settings/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

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.

Expand Down
33 changes: 29 additions & 4 deletions docs/docs/hardware/community.md
View file
Original file line number Diff line number Diff line change
@@ -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,
]
---

<head>
<title>Hardware Examples</title>
<meta charset="utf-8" />
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/hardware-examples" />
<meta property="og:title" content="Hardware Examples" />
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Add your own hardware examples to this page by creating a new file in the `docs/docs/hardware/examples` directory." />
<meta property="og:url" content="https://jan.ai/guides/hardware-examples" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-hardware-examples.png" />
</head>

## 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
Expand All @@ -18,9 +42,10 @@ docs
// highlight-next-line
└── <YOUR_BUILD_HERE>.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
Expand Down Expand Up @@ -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.
We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.
14 changes: 14 additions & 0 deletions docs/docs/hardware/concepts/gpu-and-vram.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
title: GPUs and VRAM
---

<head>
<title>Understanding GPUs and VRAM for AI and Gaming</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta name="keywords" content="GPU, VRAM, graphics card, gaming, AI, machine learning, CUDA, NVIDIA, AMD, PCIe, VRAM vs RAM, choosing GPU" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:title" content="Understanding GPUs and VRAM for AI and Gaming" />
<meta property="og:description" content="Explore the world of GPUs and VRAM, learn their importance in gaming, AI, machine learning, and more. Understand how to connect a GPU to a motherboard and choose the right graphics card for your needs." />
<meta property="og:url" content="https://jan.ai/guides/gpus-and-vram" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

## 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)
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/hardware/recommendations/by-budget.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
title: Recommended AI Hardware by Budget
---

<head>
<title>Recommended AI Hardware Builds by Budget</title>
<meta charSet="utf-8" />
<meta name="description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta name="keywords" content="AI hardware, budget PC build, entry-level AI PC, mid-range AI PC, high-end AI PC, GPU for AI, AI PC build, machine learning hardware" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:title" content="Recommended AI Hardware Builds by Budget" />
<meta property="og:description" content="Explore recommended AI hardware builds for entry-level, mid-range, and high-end budgets. Find the perfect balance of performance and cost for your AI and machine learning projects." />
<meta property="og:url" content="https://jan.ai/guides/recommended-ai-hardware-by-budget" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image.png" />
</head>

> :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
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/hardware/recommendations/by-hardware.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
title: Selecting AI Hardware
---

<head>
<title>Selecting AI Hardware</title>
<meta charset="utf-8" />
<meta name="description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta name="keywords" content="AI hardware, GPU for LLM, CPU for AI, RAM for machine learning, motherboard for AI, CUDA, VRAM, Unified Memory Architecture, M1, M2 Pro/Max, VRAM calculation" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:title" content="Selecting AI Hardware" />
<meta property="og:description" content="Guidance on selecting optimal AI hardware, including GPUs, CPUs, RAM, and motherboards for running Large Language Models (LLMs) efficiently. Explore factors like VRAM, CUDA compatibility, and unified memory architecture to build a powerful AI setup." />
<meta property="og:url" content="https://jan.ai/guides/selecting-ai-hardware" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-ai-hardware.png" />
</head>

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.
Expand Down
Loading

0 comments on commit 4a267ff

Please sign in to comment.