Merge pull request janhq#856 from janhq/fix778

docs: scaffold dev docs
orasik · Dec 13, 2023 · 89d73e7 · 89d73e7
2 parents f9b105b + 2238776
commit 89d73e7
Show file tree

Hide file tree

Showing 28 changed files with 149 additions and 40 deletions.
diff --git a/docs/docs/docs/01-overview.md b/docs/docs/docs/01-overview.md
@@ -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.
+:::
diff --git a/docs/docs/docs/02-get-started/01-build-extension.md b/docs/docs/docs/02-get-started/01-build-extension.md
@@ -0,0 +1,7 @@
+---
+title: Build an Extension
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/02-get-started/02-extension-anatomy.md b/docs/docs/docs/02-get-started/02-extension-anatomy.md
@@ -0,0 +1,9 @@
+---
+title: Anatomy of an Extension
+---
+
+:::caution
+This is currently under development.
+:::
+
+Anatomy and lifecycle
diff --git a/docs/docs/docs/02-get-started/03-use-local-server.md b/docs/docs/docs/02-get-started/03-use-local-server.md
@@ -0,0 +1,7 @@
+---
+title: Using the Local Server
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/02-get-started/04-build-on-desktop.md b/docs/docs/docs/02-get-started/04-build-on-desktop.md
@@ -0,0 +1,7 @@
+---
+title: Building for Desktop
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/02-get-started/05-build-on-mobile.md b/docs/docs/docs/02-get-started/05-build-on-mobile.md
@@ -0,0 +1,7 @@
+---
+title: Building for Mobile
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/02-get-started/README.md b/docs/docs/docs/02-get-started/README.md
@@ -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. ...
diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md
@@ -0,0 +1,7 @@
+---
+title: Core
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/03-extension-capabilities/02-common-extensions.md b/docs/docs/docs/03-extension-capabilities/02-common-extensions.md
@@ -0,0 +1,7 @@
+---
+title: Common Extensions
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/03-extension-capabilities/README.md b/docs/docs/docs/03-extension-capabilities/README.md
@@ -0,0 +1,9 @@
+---
+title: Extension Capabilities
+---
+
+# Overview
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/README.md b/docs/docs/docs/04-extension-guides/README.md
@@ -0,0 +1,7 @@
+---
+title: Extension Guides
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/assistant.md b/docs/docs/docs/04-extension-guides/assistant.md
@@ -0,0 +1,7 @@
+---
+title: Assitant
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/inference.md b/docs/docs/docs/04-extension-guides/inference.md
@@ -0,0 +1,7 @@
+---
+title: Inference
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/model.md b/docs/docs/docs/04-extension-guides/model.md
@@ -0,0 +1,7 @@
+---
+title: Model
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/monitoring.md b/docs/docs/docs/04-extension-guides/monitoring.md
@@ -0,0 +1,7 @@
+---
+title: Monitoring
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/04-extension-guides/threads-messages.md b/docs/docs/docs/04-extension-guides/threads-messages.md
@@ -0,0 +1,7 @@
+---
+title: Thread & Messages
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/05-UI/README.md b/docs/docs/docs/05-UI/README.md
@@ -0,0 +1,7 @@
+---
+title: UI
+---
+
+:::caution
+This is currently under development.
+:::
diff --git a/docs/docs/docs/assistants.md b/docs/docs/docs/assistants.md
diff --git a/docs/docs/docs/extensions.md b/docs/docs/docs/extensions.md
diff --git a/docs/docs/docs/modules.md b/docs/docs/docs/modules.md
diff --git a/docs/docs/docs/themes.md b/docs/docs/docs/themes.md
diff --git a/docs/docs/docs/tools.md b/docs/docs/docs/tools.md
diff --git a/docs/docs/intro/how-jan-works.md → docs/docs/guides/how-jan-works.md b/docs/docs/intro/how-jan-works.md → docs/docs/guides/how-jan-works.md
diff --git a/docs/docs/intro/introduction.md → docs/docs/guides/introduction.md b/docs/docs/intro/introduction.md → docs/docs/guides/introduction.md
@@ -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:
   [

diff --git a/docs/docs/docs/models.md → docs/docs/guides/models.md b/docs/docs/docs/models.md → docs/docs/guides/models.md
diff --git a/docs/docs/intro/quickstart.md → docs/docs/guides/quickstart.md b/docs/docs/intro/quickstart.md → docs/docs/guides/quickstart.md
diff --git a/docs/docs/docs/server.md → docs/docs/guides/server.md b/docs/docs/docs/server.md → docs/docs/guides/server.md
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -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: [