Merge pull request janhq#625 from janhq/internal-48

Refactor Jan Documentation
Gri-ffin · Nov 15, 2023 · a8a24e0 · a8a24e0
2 parents 89387c8 + 9ce5ed3
commit a8a24e0
Show file tree

Hide file tree

Showing 23 changed files with 33 additions and 35 deletions.
diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md
@@ -2,11 +2,11 @@
 title: About Jan
 ---
 
-Jan is a free, open source alternative to OpenAI's platform that runs on your personal computer. 
+Jan is a free, open source alternative to OpenAI's platform that runs on a local folder of open-format files. 
 
 We believe in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to be as usable and comprehensive as proprietary ones.
 
-Jan's long-term vision is to build a cognitive framework for future robots. We build towards a future where humans and businesses are augmented by practical, useful assistants in everyday life. 
+Jan's long-term vision is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life. 
 
 ## Why does Jan Exist?
 

diff --git a/docs/docs/docs/modules/03_assistants.md → docs/docs/docs/specs/assistants.md b/docs/docs/docs/modules/03_assistants.md → docs/docs/docs/specs/assistants.md
diff --git a/docs/docs/docs/modules/01_chats.md → docs/docs/docs/specs/chats.md b/docs/docs/docs/modules/01_chats.md → docs/docs/docs/specs/chats.md
diff --git a/docs/docs/docs/modules/06_files.md → docs/docs/docs/specs/files.md b/docs/docs/docs/modules/06_files.md → docs/docs/docs/specs/files.md
diff --git a/docs/docs/docs/modules/05_messages.md → docs/docs/docs/specs/messages.md b/docs/docs/docs/modules/05_messages.md → docs/docs/docs/specs/messages.md
diff --git a/docs/docs/docs/modules/02_models.md → docs/docs/docs/specs/models.md b/docs/docs/docs/modules/02_models.md → docs/docs/docs/specs/models.md
diff --git a/docs/docs/docs/modules/04_threads.md → docs/docs/docs/specs/threads.md b/docs/docs/docs/modules/04_threads.md → docs/docs/docs/specs/threads.md
diff --git a/docs/docs/guides/img/chat.png → docs/docs/getting-started/img/chat.png b/docs/docs/guides/img/chat.png → docs/docs/getting-started/img/chat.png
diff --git a/docs/docs/guides/img/downloading.png → .../docs/getting-started/img/downloading.png b/docs/docs/guides/img/downloading.png → .../docs/getting-started/img/downloading.png
diff --git a/docs/docs/guides/img/explore-model.png → ...ocs/getting-started/img/explore-model.png b/docs/docs/guides/img/explore-model.png → ...ocs/getting-started/img/explore-model.png
diff --git a/docs/docs/guides/img/jan-download.png → ...docs/getting-started/img/jan-download.png b/docs/docs/guides/img/jan-download.png → ...docs/getting-started/img/jan-download.png
diff --git a/docs/docs/guides/img/model-catelog.png → ...ocs/getting-started/img/model-catelog.png b/docs/docs/guides/img/model-catelog.png → ...ocs/getting-started/img/model-catelog.png
diff --git a/docs/docs/guides/img/model-version.png → ...ocs/getting-started/img/model-version.png b/docs/docs/guides/img/model-version.png → ...ocs/getting-started/img/model-version.png
diff --git a/docs/docs/guides/img/set-up.png → docs/docs/getting-started/img/set-up.png b/docs/docs/guides/img/set-up.png → docs/docs/getting-started/img/set-up.png
diff --git a/docs/docs/guides/img/start-model.png → .../docs/getting-started/img/start-model.png b/docs/docs/guides/img/start-model.png → .../docs/getting-started/img/start-model.png
diff --git a/docs/docs/guides/img/window-defender.png → ...s/getting-started/img/window-defender.png b/docs/docs/guides/img/window-defender.png → ...s/getting-started/img/window-defender.png
diff --git a/docs/docs/guides/install/linux.md → docs/docs/getting-started/install/linux.md b/docs/docs/guides/install/linux.md → docs/docs/getting-started/install/linux.md
diff --git a/docs/docs/guides/install/mac.md → docs/docs/getting-started/install/mac.md b/docs/docs/guides/install/mac.md → docs/docs/getting-started/install/mac.md
diff --git a/docs/docs/guides/install/windows.md → docs/docs/getting-started/install/windows.md b/docs/docs/guides/install/windows.md → docs/docs/getting-started/install/windows.md
diff --git a/docs/docs/guides/troubleshooting.md → docs/docs/getting-started/troubleshooting.md b/docs/docs/guides/troubleshooting.md → docs/docs/getting-started/troubleshooting.md
diff --git a/docs/docs/guides/overview.md b/docs/docs/guides/overview.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -134,13 +134,7 @@ const config = {
           src: "img/logo.svg",
         },
         items: [
-          // Navbar left
-          {
-            type: "docSidebar",
-            sidebarId: "guidesSidebar",
-            position: "left",
-            label: "User Guide",
-          },
+          // Navbar Left
           {
             type: "docSidebar",
             sidebarId: "docsSidebar",

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -29,39 +29,52 @@ const sidebars = {
     },
   ],
 
-  guidesSidebar: [
-    "guides/overview",
+  docsSidebar: [
     {
       type: "category",
-      label: "Installation",
-      collapsible: true,
+      label: "Getting Started",
+      collapsible: false,
       collapsed: false,
       items: [
+        "docs/introduction",
         {
-          type: "autogenerated",
-          dirName: "guides/install",
+          type: "category",
+          label: "Installation",
+          collapsible: true,
+          collapsed: true,
+          items: [
+            {
+              type: "autogenerated",
+              dirName: "getting-started/install",
+            },
+          ],
         },
+        "docs/quickstart",
       ],
     },
-    "guides/troubleshooting",
-  ],
-
-  docsSidebar: [
-    "docs/introduction",
-    "docs/quickstart",
     {
       type: "category",
-      label: "Modules",
-      collapsible: true,
+      label: "Building Jan",
+      collapsible: false,
       collapsed: false,
       items: [
+        "docs/user-interface",
         {
-          type: "autogenerated",
-          dirName: "docs/modules",
+          type: "category",
+          label: "Specifications",
+          collapsible: true,
+          collapsed: true,
+          items: [
+            "docs/specs/chats",
+            "docs/specs/models",
+            "docs/specs/threads",
+            "docs/specs/messages",
+            "docs/specs/assistants",
+            "docs/specs/files",
+          ],
         },
       ],
     },
-    "docs/user-interface",
   ],
 
   apiSidebar: [