docs: scaffold docs
This commit is contained in:
parent
5dd5702a87
commit
fe343a7f8d
20
docs/docs/docs/01-overview.md
Normal file
20
docs/docs/docs/01-overview.md
Normal 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
7
docs/docs/docs/02-get-started/01-build-extension.md
Normal 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
9
docs/docs/docs/02-get-started/02-extension-anatomy.md
Normal 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
7
docs/docs/docs/02-get-started/03-use-local-server.md
Normal 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
7
docs/docs/docs/02-get-started/04-build-on-desktop.md
Normal 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
7
docs/docs/docs/02-get-started/05-build-on-mobile.md
Normal 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
12
docs/docs/docs/02-get-started/README.md
Normal 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
7
docs/docs/docs/03-extension-capabilities/01-Core.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Core
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Common Extensions
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
9
docs/docs/docs/03-extension-capabilities/README.md
Normal file
9
docs/docs/docs/03-extension-capabilities/README.md
Normal 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
7
docs/docs/docs/04-extension-guides/README.md
Normal 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
7
docs/docs/docs/04-extension-guides/assistant.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Assitant
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
7
docs/docs/docs/04-extension-guides/inference.md
Normal file
7
docs/docs/docs/04-extension-guides/inference.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Inference
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
7
docs/docs/docs/04-extension-guides/model.md
Normal file
7
docs/docs/docs/04-extension-guides/model.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Model
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
7
docs/docs/docs/04-extension-guides/monitoring.md
Normal file
7
docs/docs/docs/04-extension-guides/monitoring.md
Normal 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
7
docs/docs/docs/04-extension-guides/threads-messages.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: Thread & Messages
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
7
docs/docs/docs/05-UI/README.md
Normal file
7
docs/docs/docs/05-UI/README.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: UI
|
||||||
|
---
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
This is currently under development.
|
||||||
|
:::
|
||||||
@ -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 ]
|
|
||||||
---
|
|
||||||
@ -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.
|
|
||||||
@ -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 ]
|
|
||||||
---
|
|
||||||
@ -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 ]
|
|
||||||
---
|
|
||||||
@ -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 ]
|
|
||||||
---
|
|
||||||
@ -45,11 +45,10 @@ const sidebars = {
|
|||||||
],
|
],
|
||||||
|
|
||||||
developerSidebar: [
|
developerSidebar: [
|
||||||
"docs/extensions",
|
{
|
||||||
"docs/assistants",
|
type: "autogenerated",
|
||||||
"docs/themes",
|
dirName: "docs",
|
||||||
"docs/tools",
|
},
|
||||||
"docs/modules",
|
|
||||||
],
|
],
|
||||||
|
|
||||||
specsSidebar: [
|
specsSidebar: [
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user