Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: index page autogenerated (#1330)

Browse Source 
docs: index page autogenerated
This commit is contained in:
Hieu 2024-01-04 14:10:38 +07:00 committed by GitHub
commit ed3e3600aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
41 changed files with 415 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/developer/02-build-assistant/01-your-first-assistant.md
View File

@ -1,9 +1,23 @@
---
title: Your First Assistant
slug: /developer/build-assistant/your-first-assistant/
description: A quick start on how to build an assistant.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
quick start,
build assistant,
]
---
:::caution
This is currently under development.
:::
A quickstart on how to build an assistant

17
docs/docs/developer/02-build-assistant/02-assistant-anatomy.md
View File

@ -1,9 +1,22 @@
---
title: Anatomy of an Assistant
slug: /developer/build-assistant/assistant-anatomy/
description: An overview of assistant.json
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build assistant,
assistant anatomy,
]
---
:::caution
This is currently under development.
:::
An overview of assistant.json

17
docs/docs/developer/02-build-assistant/03-package-your-assistant.md
View File

@ -1,9 +1,22 @@
---
title: Package your Assistant
slug: /developer/build-assistant/package-your-assistant/
description: Package your assistant for sharing and publishing.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
quick start,
build assistant,
]
---
:::caution
This is currently under development.
:::
Packaging, exporting, sharing, publishing an assistant to Hub

12
docs/docs/developer/02-build-assistant/README.md
View File

@ -1,12 +0,0 @@
---
title: Build an Assistant
---
:::caution
This is currently under development.
:::
In this tutorial you will learn:
-
-

25
docs/docs/developer/02-build-assistant/README.mdx Normal file
View File

@ -0,0 +1,25 @@
---
title: Build an Assistant
slug: /developer/build-assistant
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,
build assistant,
]
---
:::caution
This is currently under development.
:::
import DocCardList from "@theme/DocCardList";
<DocCardList />

19
docs/docs/developer/03-build-engine/01-your-first-engine.md
View File

@ -1,9 +1,24 @@
---
title: Your First Assistant
title: Your First Engine
slug: /developer/build-engine/your-first-engine/
description: A quick start on how to build your first engine
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
quick start,
build engine,
]
---
:::caution
This is currently under development.
:::
A quickstart on how to integrate tensorrt llm
A quickstart on how to integrate tensorrt llm

17
docs/docs/developer/03-build-engine/02-engine-anatomy.md
View File

@ -1,9 +1,22 @@
---
title: Anatomy of an Engine
slug: /developer/build-engine/engine-anatomy
description: An overview of engine.json
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build engine,
engine anatomy,
]
---
:::caution
This is currently under development.
:::
An overview of engine.json

19
docs/docs/developer/03-build-engine/03-package-your-engine.md
View File

@ -1,9 +1,22 @@
---
title: Package your Extension
title: Package your Engine
slug: /developer/build-engine/package-your-engine/
description: Package your engine for sharing and publishing.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build engine,
engine anatomy,
]
---
:::caution
This is currently under development.
:::
Packaging, exporting, sharing, publishing an engine config to Hub

12
docs/docs/developer/03-build-engine/README.md
View File

@ -1,12 +0,0 @@
---
title: Build an Inference Engine
---
:::caution
This is currently under development.
:::
In this tutorial you will learn:
-
-

25
docs/docs/developer/03-build-engine/README.mdx Normal file
View File

@ -0,0 +1,25 @@
---
title: Build an Inference Engine
slug: /developer/build-engine/
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,
build assistant,
]
---
:::caution
This is currently under development.
:::
import DocCardList from "@theme/DocCardList";
<DocCardList />

17
docs/docs/developer/04-build-extension/01-your-first-extension.md
View File

@ -1,9 +1,22 @@
---
title: Your First Extension
slug: /developer/build-extension/your-first-extension/
description: A quick start on how to build your first extension
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
quick start,
build extension,
]
---
:::caution
This is currently under development.
:::
A quickstart on tensorrt-llm impl

17
docs/docs/developer/04-build-extension/02-extension-anatomy.md
View File

@ -1,9 +1,22 @@
---
title: Anatomy of an Extension
slug: /developer/build-extension/extension-anatomy
description: An overview of extensions.json
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build extension,
extension anatomy,
]
---
:::caution
This is currently under development.
:::
An overview of engine.json

9
docs/docs/developer/04-build-extension/03-package-your-assistant.md
View File

@ -1,9 +0,0 @@
---
title: Package your Extension
---
:::caution
This is currently under development.
:::
Packaging, exporting, sharing, publishing an extension to Hub

22
docs/docs/developer/04-build-extension/03-package-your-extension.md Normal file
View File

@ -0,0 +1,22 @@
---
title: Package your Engine
slug: /developer/build-extension/package-your-extension/
description: Package your extension for sharing and publishing.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
build extension,
extension anatomy,
]
---
:::caution
This is currently under development.
:::

9
docs/docs/developer/04-build-extension/README.md
View File

@ -1,9 +0,0 @@
---
title: Build an Extension
---
# Overview
:::caution
This is currently under development.
:::

25
docs/docs/developer/04-build-extension/README.mdx Normal file
View File

@ -0,0 +1,25 @@
---
title: Build an Extension
slug: /developer/build-extension/
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,
build extension,
]
---
:::caution
This is currently under development.
:::
import DocCardList from "@theme/DocCardList";
<DocCardList />

5
docs/docs/docs/engineering/README.md
View File

@ -1,5 +0,0 @@
---
title: Engineering Specs
---
Talk about CoreSDK here

24
docs/docs/docs/engineering/README.mdx Normal file
View File

@ -0,0 +1,24 @@
---
title: Engineering Specs
slug: /docs/engineering
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,
spec,
engineering,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList className="DocCardList--no-description" />
Talk about CoreSDK here

3
docs/docs/docs/product/README.md
View File

@ -1,3 +0,0 @@
---
title: Product Specs
---

22
docs/docs/docs/product/README.mdx Normal file
View File

@ -0,0 +1,22 @@
---
title: Product Specs
slug: /docs/product
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,
spec,
product,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList className="DocCardList--no-description" />

3
docs/docs/guides/03-chatting/README.md
View File

@ -1,3 +0,0 @@
---
title: Chatting
---

23
docs/docs/guides/03-chatting/README.mdx Normal file
View File

@ -0,0 +1,23 @@
---
title: Chatting
slug: /guides/chatting/
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,
chatting,
]
---
This guide is designed to help you maximize your experience with Jan, covering everything from starting engaging threads to managing your chat history effectively.
import DocCardList from "@theme/DocCardList";
<DocCardList />

2
docs/docs/guides/04-using-models/01-install-from-hub.mdx
View File

@ -1,6 +1,6 @@
---
title: Install Models from the Hub
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Guide to install models from the Hub.
keywords:
[
Jan AI,

2
docs/docs/guides/04-using-models/02-import-manually.mdx
View File

@ -1,7 +1,7 @@
---
title: Import Models Manually
slug: /guides/using-models/import-manually
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Guide to manually import a local model into Jan.
keywords:
[
Jan AI,

2
docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx
View File

@ -1,7 +1,7 @@
---
title: Integrate With a Remote Server
slug: /guides/using-models/integrate-with-remote-server
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Guide to integrate with a remote server.
keywords:
[
Jan AI,

3
docs/docs/guides/04-using-models/README.md
View File

@ -1,3 +0,0 @@
---
title: Using Models
---

21
docs/docs/guides/04-using-models/README.mdx Normal file
View File

@ -0,0 +1,21 @@
---
title: Using Models
slug: /guides/using-models/
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,
using-models,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList className="DocCardList" />

2
docs/docs/guides/05-using-server/01-server.md
View File

@ -1,6 +1,6 @@
---
title: Connect to Server
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Connect to Jan's built-in API server.
keywords:
[
Jan AI,

3
docs/docs/guides/05-using-server/README.md
View File

@ -1,3 +0,0 @@
---
title: Using the Local Server
---

21
docs/docs/guides/05-using-server/README.mdx Normal file
View File

@ -0,0 +1,21 @@
---
title: Using the Local Server
slug: /guides/using-server/
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,
using-server,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList />

16
docs/docs/guides/06-using-extensions/01-import-extensions.md
View File

@ -1,3 +1,17 @@
---
title: Import Extensions
---
slug: /guides/using-extensions/import-extensions/
description: Import extensions into Jan.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
using-models,
]
---

18
docs/docs/guides/06-using-extensions/02-extension-settings.md
View File

@ -1,5 +1,17 @@
---
title: Extension Settings
---
TODO: how to configure settings for extensions
slug: /guides/using-extensions/extension-settings/
description: Configure settings for extensions.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
using-models,
]
---

3
docs/docs/guides/06-using-extensions/README.md
View File

@ -1,3 +0,0 @@
---
title: Using Extensions
---

21
docs/docs/guides/06-using-extensions/README.mdx Normal file
View File

@ -0,0 +1,21 @@
---
title: Using Extensions
slug: /guides/using-extensions/
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,
using-extensions,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList />

2
docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx
View File

@ -1,7 +1,7 @@
---
title: Stuck on a Broken Build
slug: /troubleshooting/stuck-on-broken-build
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Troubleshooting steps to resolve issues related to broken builds.
keywords:
[
Jan AI,

3
docs/docs/guides/07-troubleshooting/README.md
View File

@ -1,3 +0,0 @@
---
title: Troubleshooting
---

21
docs/docs/guides/07-troubleshooting/README.mdx Normal file
View File

@ -0,0 +1,21 @@
---
title: Troubleshooting
slug: /guides/troubleshooting/
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,
troubleshooting,
]
---
import DocCardList from "@theme/DocCardList";
<DocCardList />

3
docs/src/css/custom.css Normal file
View File

@ -0,0 +1,3 @@
.DocCardList--no-description .card p {
display: none;
}

2
docs/src/css/custom_toc.css
View File

@ -2,4 +2,4 @@
font-weight: bold;
margin-bottom: 16px;
margin-top: -20px;
}
}

2
docs/src/styles/main.scss
View File

@ -11,3 +11,5 @@
@import "./tweaks/markdown.scss";
@import "./tweaks/redocusaurus.scss";
@import "./tweaks/sidebar.scss";
@import "../css/custom.css";

2
docs/src/styles/tweaks/markdown.scss
View File

@ -1,6 +1,6 @@
.theme-doc-markdown {
a {
@apply text-blue-600 dark:text-blue-400 underline;
@apply text-blue-600 dark:text-blue-400;
}
ul {
list-style: revert;