Merge pull request #856 from janhq/fix778

docs: scaffold dev docs
This commit is contained in:
0xSage 2023-12-13 14:11:43 +08:00 committed by GitHub
commit 89d73e7f30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 149 additions and 40 deletions

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.
:::

View File

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

View File

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

View File

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

View File

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

View File

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

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

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

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.

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

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

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

View File

@ -1,6 +1,6 @@
---
title: Introduction
slug: /docs
slug: /guides
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[

View File

@ -17,10 +17,10 @@ const sidebars = {
{
type: "category",
label: "Introduction",
link: { type: "doc", id: "intro/introduction" },
link: { type: "doc", id: "guides/introduction" },
collapsible: true,
collapsed: true,
items: ["intro/quickstart", "intro/how-jan-works"],
items: ["guides/quickstart", "guides/how-jan-works"],
},
{
type: "category",
@ -40,16 +40,15 @@ const sidebars = {
label: "Using Jan",
collapsible: true,
collapsed: true,
items: ["docs/models", "docs/server"],
items: ["guides/models", "guides/server"],
},
],
developerSidebar: [
"docs/extensions",
"docs/assistants",
"docs/themes",
"docs/tools",
"docs/modules",
{
type: "autogenerated",
dirName: "docs",
},
],
specsSidebar: [