Skip to content

Commit

Permalink
docs: configure index page
Browse files Browse the repository at this point in the history
  • Loading branch information
0xHieu01 committed Jan 4, 2024
1 parent 566a5a3 commit 1cea349
Show file tree
Hide file tree
Showing 41 changed files with 423 additions and 91 deletions.
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 2 deletions docs/docs/developer/02-build-assistant/02-assistant-anatomy.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 12 deletions docs/docs/developer/02-build-assistant/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/docs/developer/02-build-assistant/README.mdx
Original file line number Diff line number Diff line change
@@ -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 changes: 17 additions & 2 deletions docs/docs/developer/03-build-engine/01-your-first-engine.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 2 deletions docs/docs/developer/03-build-engine/02-engine-anatomy.md
Original file line number Diff line number Diff line change
@@ -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 changes: 16 additions & 3 deletions docs/docs/developer/03-build-engine/03-package-your-engine.md
Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 12 deletions docs/docs/developer/03-build-engine/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/docs/developer/03-build-engine/README.mdx
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 2 deletions docs/docs/developer/04-build-extension/01-your-first-extension.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 2 deletions docs/docs/developer/04-build-extension/02-extension-anatomy.md
Original file line number Diff line number Diff line change
@@ -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

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 9 deletions docs/docs/developer/04-build-extension/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/docs/developer/04-build-extension/README.mdx
Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 5 deletions docs/docs/docs/engineering/README.md

This file was deleted.

24 changes: 24 additions & 0 deletions docs/docs/docs/engineering/README.mdx
Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 3 deletions docs/docs/docs/product/README.md

This file was deleted.

Loading

0 comments on commit 1cea349

Please sign in to comment.