Refactor structure

lyqandy · Nov 18, 2023 · 1725819 · 1725819
1 parent 88ea34a
commit 1725819
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 17 deletions.
diff --git a/docs/docs/guide/assistants.md → docs/docs/docs/assistants.md b/docs/docs/guide/assistants.md → docs/docs/docs/assistants.md
diff --git a/docs/docs/guide/extensions.md → docs/docs/docs/extensions.md b/docs/docs/guide/extensions.md → docs/docs/docs/extensions.md
diff --git a/docs/docs/guide/models.md → docs/docs/docs/models.md b/docs/docs/guide/models.md → docs/docs/docs/models.md
diff --git a/docs/docs/guide/modules.md → docs/docs/docs/modules.md b/docs/docs/guide/modules.md → docs/docs/docs/modules.md
diff --git a/docs/docs/guide/server.md → docs/docs/docs/server.md b/docs/docs/guide/server.md → docs/docs/docs/server.md
diff --git a/docs/docs/guide/themes.md → docs/docs/docs/themes.md b/docs/docs/guide/themes.md → docs/docs/docs/themes.md
diff --git a/docs/docs/guide/tools.md → docs/docs/docs/tools.md b/docs/docs/guide/tools.md → docs/docs/docs/tools.md
diff --git a/docs/docs/intro/introduction.md b/docs/docs/intro/introduction.md
@@ -1,6 +1,6 @@
 ---
 title: Introduction
-slug: /docs
+slug: /intro
 ---
 
 Jan is a ChatGPT-alternative that runs on your own computer. 
@@ -11,23 +11,22 @@ Jan ships with an [OpenAI-compatible API](/api) and a powerful [Assistant framew
 
 ## Why Jan?
 
-💻 **Own your AI**<br />
+#### 💻 Own your AI
 Jan runs 100% on your own machine, [predictably](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3), privately and even offline. No one else can see your conversations, not even us. 
 
-🏗️ **Customizability**<br />
+#### 🏗️ Extensions
 Jan ships with a powerful [extension framework](/guide/extensions), which allows developers to extend and customize Jan's functionality. In fact, most core modules of Jan are [built as extensions](/specs/architecture) and use the same extensions API. 
 
-🗂️ **Open File Formats**<br />
+#### 🗂️ Open File Formats
 Jan stores data in a [local folder of non-proprietary files](/specs/data-structures). You're never locked-in and can do what you want with your data with extensions, or even a different app. 
 
-🌍 **Open Source**<br />
-Both Jan and [Nitro](https://nitro.jan.ai), our lightweight inference engine, are open source via the [AGPLv3 license](https://github.com/janhq/jan/blob/main/LICENSE). 
+#### 🌍 Open Source
+Both Jan and [Nitro](https://nitro.jan.ai), our lightweight inference engine, are licensed via the open source [AGPLv3 license](https://github.com/janhq/jan/blob/main/LICENSE). 
 
 <!-- ## Design Principles -->
 
 <!-- OpenAI meets VSCode meets Obsidian. 
 
-
 Minimalism: https://docusaurus.io/docs#design-principles. Not having abstractions is better than having the wrong abstractions. Assistants as code. Only including features that are absolutely necessary in the Jan API. 
 
 File-based: User should be able to look at a Jan directory and intuit how it works. Transparency. Editing things via a text editor, vs. needing a database tool for SQLite. 

diff --git a/docs/docs/specs/architecture.md b/docs/docs/specs/architecture.md
@@ -5,6 +5,21 @@ title: Architecture
 - Jan is built using modules
 - Plugin architecture (on Pluggable-Electron)
 
+Jan is comprised of system-level modules that mirror OpenAI’s, exposing similar APIs and objects
+
+- Modules are modular, atomic implementations of a single OpenAI-compatible endpoint
+- Modules can be swapped out for alternate implementations
+  - The default `messages` module persists messages in thread-specific `.json`
+  - `messages-postgresql` uses Postgres for production-grade cloud-native environments
+
+| Jan Module | Description   | API Docs                     |
+| ---------- | ------------- | ---------------------------- |
+| Chat       | Inference     | [/chat](/api/chat)           |
+| Models     | Models        | [/model](/api/model)         |
+| Assistants | Apps          | [/assistant](/api/assistant) |
+| Threads    | Conversations | [/thread](/api/thread)       |
+| Messages   | Messages      | [/message](/api/message)     |
+
 ## Concepts
 
 ```mermaid

diff --git a/docs/docs/specs/jan.md b/docs/docs/specs/jan.md
@@ -1,5 +1,5 @@
 ---
-title: Jan
+title: Jan (Assistant)
 ---
 
 ## Jan: a "global" assistant

diff --git a/docs/docs/specs/settings.md b/docs/docs/specs/settings.md
@@ -1,3 +1,3 @@
 ---
-title: .jan
+title: Settings
 ---
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -34,20 +34,15 @@ const sidebars = {
       label: "Using Jan",
       collapsible: true,
       collapsed: true,
-      items: ["guide/models", "guide/server"],
+      items: ["docs/models", "docs/server"],
     },
     {
       type: "category",
       label: "Extending Jan",
-      link: { type: "doc", id: "guide/extensions" },
+      link: { type: "doc", id: "docs/extensions" },
       collapsible: true,
       collapsed: true,
-      items: [
-        "guide/assistants",
-        "guide/themes",
-        "guide/tools",
-        "guide/modules",
-      ],
+      items: ["docs/assistants", "docs/themes", "docs/tools", "docs/modules"],
     },
     {
       type: "category",