Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Redirected the broken links, updated the website title and updated slug for developer section #2438

Merged
merged 9 commits into from
Mar 20, 2024
36 changes: 20 additions & 16 deletions docs/blog/2024-01-10-bitdefender-false-positive-flag.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
---
title: "Post Mortem: Bitdefender False Positive Flag"
title: 'Post Mortem: Bitdefender False Positive Flag'
description: "10th January 2024, Jan's 0.4.4 Release on Windows triggered Bitdefender to incorrectly flag it as infected with Gen:Variant.Tedy.258323, leading to automatic quarantine warnings on users' computers."
slug: /postmortems/january-10-2024-bitdefender-false-positive-flag
tags: [Postmortem]
keywords:
[
postmortem,
bitdefender,
false positive,
antivirus,
jan,
nitro,
incident,
incident response,
supply chain security,
user communication,
documentation,
antivirus compatibility,
cross-platform testing,
proactive incident response,
user education,
lessons learned,
]
---

<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
1 change: 1 addition & 0 deletions docs/blog/2024-03-19-TensorRT-LLM.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Jan now supports TensorRT-LLM
description: Jan has added for Nvidia's TensorRT-LLM, a hardware-optimized LLM inference engine that runs very fast on Nvidia GPUs
tags: [Nvidia, TensorRT-LLM]
keywords: [Nvidia, TensorRT-LLM]
---

Jan now supports [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) as an alternative inference engine. TensorRT-LLM is a hardware-optimized LLM inference engine that compiles models to [run extremely fast on Nvidia GPUs](https://blogs.nvidia.com/blog/tensorrt-llm-windows-stable-diffusion-rtx/).
Expand Down
14 changes: 0 additions & 14 deletions docs/docs/about/2035.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@
title: Jan's Vision for 2035
---

<head>
<title>Jan's Vision for 2035</title>
<meta charset="utf-8" />
<meta name="description" content="Discover Jan's vision for the year 2035, where it aims to transform into a robotics company. Learn about its planning parameters, 10-year vision, 2-week sprint, and success measurement through Quarterly OKRs." />
<meta name="keywords" content="Jan, vision, 2035, robotics company, planning parameters, 10-year vision, 2-week sprint, Quarterly OKRs" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/jans-vision-for-2035" />
<meta property="og:title" content="Jan's Vision for 2035" />
<meta property="og:description" content="Discover Jan's vision for the year 2035, where it aims to transform into a robotics company. Learn about its planning parameters, 10-year vision, 2-week sprint, and success measurement through Quarterly OKRs." />
<meta property="og:url" content="https://jan.ai/jans-vision-for-2035" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-jans-vision.png" />
</head>

[Jan 2035: A Robotics Company](https://hackmd.io/QIWyYbNNQVWVbupuI3kjAA)

We only have 2 planning parameters:
Expand Down
23 changes: 5 additions & 18 deletions docs/docs/about/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,21 @@ slug: /about
description: Jan is a desktop application that turns computers into thinking machines.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
about Jan,
desktop application,
thinking machine,
]
---

<head>
<title>About Jan</title>
<meta charset="utf-8" />
<meta name="description" content="Discover Jan, a desktop application that turns computers into thinking machines. Learn about its features, principles, vision, and how to get involved with the Jan Labs team." />
<meta name="keywords" content="Jan, Jan AI, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, desktop application, thinking machine, about Jan" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/about" />
<meta property="og:title" content="About Jan" />
<meta property="og:description" content="Discover Jan, a desktop application that turns computers into thinking machines. Learn about its features, principles, vision, and how to get involved with the Jan Labs team." />
<meta property="og:url" content="https://jan.ai/about" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-about-jan.png" />
</head>

Jan turns computers into thinking machines to change how we use them.
Jan is created and maintained by Jan Labs, a robotics company.

Expand Down
14 changes: 0 additions & 14 deletions docs/docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@
title: Frequently Asked Questions (FAQ) - Jan
---

<head>
<title>Frequently Asked Questions (FAQ)</title>
<meta charset="utf-8" />
<meta name="description" content="Explore frequently asked questions about Jan, including its features, compatibility, privacy policy, usage, and community involvement." />
<meta name="keywords" content="Jan, frequently asked questions, FAQ, about Jan, usage, compatibility, privacy, community, contribution, troubleshooting, self-hosting, hiring" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/faq" />
<meta property="og:title" content="Frequently Asked Questions (FAQ)" />
<meta property="og:description" content="Explore frequently asked questions about Jan, including its features, compatibility, privacy policy, usage, and community involvement." />
<meta property="og:url" content="https://jan.ai/faq" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-faq.png" />
</head>

# Frequently Asked Questions (FAQ)

## What is Jan?
Expand Down
14 changes: 0 additions & 14 deletions docs/docs/about/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,5 @@
title: Roadmap
---

<head>
<title>Roadmap</title>
<meta charset="utf-8" />
<meta name="description" content="Explore Jan's roadmap to see the immediate and longer-term plans for development and features." />
<meta name="keywords" content="Jan, roadmap, development, features, immediate roadmap, longer-term roadmap, GitHub, Discord" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/roadmap" />
<meta property="og:title" content="Roadmap" />
<meta property="og:description" content="Explore Jan's roadmap to see the immediate and longer-term plans for development and features." />
<meta property="og:url" content="https://jan.ai/roadmap" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-roadmap.png" />
</head>

- [ ] [Immediate Roadmap on Github](https://github.com/orgs/janhq/projects/5/views/16)
- [ ] [Longer-term Roadmap on Discord](https://discord.gg/Ey62mynnYr)
20 changes: 5 additions & 15 deletions docs/docs/acknowledgements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,20 @@ description: Jan is a ChatGPT-alternative that runs on your own computer, with a
slug: /acknowledgements
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
acknowledgements,
third-party libraries,
]
---

<head>
<meta name="description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
<meta name="keywords" content="Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model, acknowledgements, third-party libraries"/>
<meta property="og:title" content="Acknowledgements - Jan"/>
<meta property="og:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
<meta property="og:url" content="https://jan.ai/acknowledgements"/>
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Acknowledgements - Jan"/>
<meta name="twitter:description" content="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. Explore the third-party libraries that have contributed to the development of Jan."/>
</head>

# Acknowledgements

We would like to express our gratitude to the following third-party libraries that have made the development of Jan possible.
Expand Down
28 changes: 10 additions & 18 deletions docs/docs/community/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,23 @@ slug: /community
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
about Jan,
desktop application,
thinking machine,
community,
socials,
]
---

<head>
<title>Jan's Community</title>
<meta charset="utf-8" />
<meta name="description" content="Join Jan's community to connect with other users, stay updated, and explore career opportunities." />
<meta name="keywords" content="Jan, community, Discord, Twitter, HuggingFace, LinkedIn, Reddit, newsletter, careers" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://jan.ai/community" />
<meta property="og:title" content="Jan's Community" />
<meta property="og:description" content="Join Jan's community to connect with other users, stay updated, and explore career opportunities." />
<meta property="og:url" content="https://jan.ai/community" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://jan.ai/img/og-image-community.png" />
</head>

## Socials

- [Discord](https://discord.gg/SH3DGmUs6b)
Expand Down
24 changes: 6 additions & 18 deletions docs/docs/developer/01-overview/01-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,19 @@ slug: /developer/architecture
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
architecture,
]
---

<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
24 changes: 6 additions & 18 deletions docs/docs/developer/01-overview/02-file-based.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,19 @@ slug: /developer/file-based
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
file based approach,
]
---

<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
24 changes: 6 additions & 18 deletions docs/docs/developer/01-overview/03-user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,19 @@ slug: /developer/ui
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
UI kit,
]
---

<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
23 changes: 5 additions & 18 deletions docs/docs/developer/01-overview/04-install-and-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,21 @@ slug: /developer/prereq
description: Guide to install and setup Jan for development.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
Rethink the Computer,
local AI,
private AI,
privacy focus,
free and open source,
private and offline,
conversational AI,
no-subscription fee,
large language model,
large language models,
installation,
prerequisites,
developer setup,
]
---

<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
Loading
Loading