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

docs: scaffold docs

Browse Source
This commit is contained in:
0xSage 2023-12-13 14:08:07 +08:00
parent 5dd5702a87
commit fe343a7f8d
23 changed files with 145 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/docs/01-overview.md Normal file
View File

@ -0,0 +1,20 @@
---
title: Overview
slug: /docs
description: Jan Docs | 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,
]
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/02-get-started/01-build-extension.md Normal file
View File

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

9
docs/docs/docs/02-get-started/02-extension-anatomy.md Normal file
View File

@ -0,0 +1,9 @@
---
title: Anatomy of an Extension
---
:::caution
This is currently under development.
:::
Anatomy and lifecycle

7
docs/docs/docs/02-get-started/03-use-local-server.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Using the Local Server
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/02-get-started/04-build-on-desktop.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Building for Desktop
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/02-get-started/05-build-on-mobile.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Building for Mobile
---
:::caution
This is currently under development.
:::

12
docs/docs/docs/02-get-started/README.md Normal file
View File

@ -0,0 +1,12 @@
---
title: Get Started
---
:::caution
This is currently under development.
:::
There are various ways to build on top of Jan.
1. Use Jan as a local AI server
2. Build a cross-platform extension for Desktop application
3. ...

7
docs/docs/docs/03-extension-capabilities/01-Core.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Core
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/03-extension-capabilities/02-Common Extensions.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Common Extensions
---
:::caution
This is currently under development.
:::

9
docs/docs/docs/03-extension-capabilities/README.md Normal file
View File

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

7
docs/docs/docs/04-extension-guides/README.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Extension Guides
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/04-extension-guides/assistant.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Assitant
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/04-extension-guides/inference.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Inference
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/04-extension-guides/model.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Model
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/04-extension-guides/monitoring.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Monitoring
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/04-extension-guides/threads-messages.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Thread & Messages
---
:::caution
This is currently under development.
:::

7
docs/docs/docs/05-UI/README.md Normal file
View File

@ -0,0 +1,7 @@
---
title: UI
---
:::caution
This is currently under development.
:::

5
docs/docs/docs/assistants.md
View File

@ -1,5 +0,0 @@
---
title: Build an 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 ]
---

11
docs/docs/docs/extensions.md
View File

@ -1,11 +0,0 @@
---
title: Extending Jan
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 ]
---
## Overview
- Jan exports a developer SDK which lets you customize assistants, Jan app, and more.
- Jan exports a AI-friendly UI kit which lets people customize the [Jan UI](/specs/user-interface).
- Jan provisions a local AI server which lets you built external applications on other platforms.

5
docs/docs/docs/modules.md
View File

@ -1,5 +0,0 @@
---
title: Build a Module
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 ]
---

5
docs/docs/docs/themes.md
View File

@ -1,5 +0,0 @@
---
title: Build a Theme
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 ]
---

5
docs/docs/docs/tools.md
View File

@ -1,5 +0,0 @@
---
title: Build a Tool
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 ]
---

9
docs/sidebars.js
View File

@ -45,11 +45,10 @@ const sidebars = {
],
developerSidebar: [
"docs/extensions",
"docs/assistants",
"docs/themes",
"docs/tools",
"docs/modules",
{
type: "autogenerated",
dirName: "docs",
},
],
specsSidebar: [