From fc43f1499665664dfae04a3c3ef60d4ac7472698 Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Wed, 15 Nov 2023 17:30:17 +0800 Subject: [PATCH 1/2] Reorganize Documentation --- docs/docs/about/about.md | 4 +- .../03_assistants.md => specs/assistants.md} | 0 .../{modules/01_chats.md => specs/chats.md} | 0 .../{modules/06_files.md => specs/files.md} | 0 .../05_messages.md => specs/messages.md} | 0 .../{modules/02_models.md => specs/models.md} | 0 .../04_threads.md => specs/threads.md} | 0 .../{guides => getting-started}/img/chat.png | Bin .../img/downloading.png | Bin .../img/explore-model.png | Bin .../img/jan-download.png | Bin .../img/model-catelog.png | Bin .../img/model-version.png | Bin .../img/set-up.png | Bin .../img/start-model.png | Bin .../img/window-defender.png | Bin .../install/linux.md | 0 .../install/mac.md | 0 .../install/windows.md | 0 .../troubleshooting.md | 0 docs/docs/guides/overview.md | 9 --- docs/docusaurus.config.js | 8 +-- docs/sidebars.js | 59 +++++++++++------- 23 files changed, 39 insertions(+), 41 deletions(-) rename docs/docs/docs/{modules/03_assistants.md => specs/assistants.md} (100%) rename docs/docs/docs/{modules/01_chats.md => specs/chats.md} (100%) rename docs/docs/docs/{modules/06_files.md => specs/files.md} (100%) rename docs/docs/docs/{modules/05_messages.md => specs/messages.md} (100%) rename docs/docs/docs/{modules/02_models.md => specs/models.md} (100%) rename docs/docs/docs/{modules/04_threads.md => specs/threads.md} (100%) rename docs/docs/{guides => getting-started}/img/chat.png (100%) rename docs/docs/{guides => getting-started}/img/downloading.png (100%) rename docs/docs/{guides => getting-started}/img/explore-model.png (100%) rename docs/docs/{guides => getting-started}/img/jan-download.png (100%) rename docs/docs/{guides => getting-started}/img/model-catelog.png (100%) rename docs/docs/{guides => getting-started}/img/model-version.png (100%) rename docs/docs/{guides => getting-started}/img/set-up.png (100%) rename docs/docs/{guides => getting-started}/img/start-model.png (100%) rename docs/docs/{guides => getting-started}/img/window-defender.png (100%) rename docs/docs/{guides => getting-started}/install/linux.md (100%) rename docs/docs/{guides => getting-started}/install/mac.md (100%) rename docs/docs/{guides => getting-started}/install/windows.md (100%) rename docs/docs/{guides => getting-started}/troubleshooting.md (100%) delete mode 100644 docs/docs/guides/overview.md diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md index 7931c030f..3ed5750c4 100644 --- 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 b/docs/docs/docs/specs/assistants.md similarity index 100% rename from docs/docs/docs/modules/03_assistants.md rename to docs/docs/docs/specs/assistants.md diff --git a/docs/docs/docs/modules/01_chats.md b/docs/docs/docs/specs/chats.md similarity index 100% rename from docs/docs/docs/modules/01_chats.md rename to docs/docs/docs/specs/chats.md diff --git a/docs/docs/docs/modules/06_files.md b/docs/docs/docs/specs/files.md similarity index 100% rename from docs/docs/docs/modules/06_files.md rename to docs/docs/docs/specs/files.md diff --git a/docs/docs/docs/modules/05_messages.md b/docs/docs/docs/specs/messages.md similarity index 100% rename from docs/docs/docs/modules/05_messages.md rename to docs/docs/docs/specs/messages.md diff --git a/docs/docs/docs/modules/02_models.md b/docs/docs/docs/specs/models.md similarity index 100% rename from docs/docs/docs/modules/02_models.md rename to docs/docs/docs/specs/models.md diff --git a/docs/docs/docs/modules/04_threads.md b/docs/docs/docs/specs/threads.md similarity index 100% rename from docs/docs/docs/modules/04_threads.md rename to docs/docs/docs/specs/threads.md diff --git a/docs/docs/guides/img/chat.png b/docs/docs/getting-started/img/chat.png similarity index 100% rename from docs/docs/guides/img/chat.png rename to docs/docs/getting-started/img/chat.png diff --git a/docs/docs/guides/img/downloading.png b/docs/docs/getting-started/img/downloading.png similarity index 100% rename from docs/docs/guides/img/downloading.png rename to docs/docs/getting-started/img/downloading.png diff --git a/docs/docs/guides/img/explore-model.png b/docs/docs/getting-started/img/explore-model.png similarity index 100% rename from docs/docs/guides/img/explore-model.png rename to docs/docs/getting-started/img/explore-model.png diff --git a/docs/docs/guides/img/jan-download.png b/docs/docs/getting-started/img/jan-download.png similarity index 100% rename from docs/docs/guides/img/jan-download.png rename to docs/docs/getting-started/img/jan-download.png diff --git a/docs/docs/guides/img/model-catelog.png b/docs/docs/getting-started/img/model-catelog.png similarity index 100% rename from docs/docs/guides/img/model-catelog.png rename to docs/docs/getting-started/img/model-catelog.png diff --git a/docs/docs/guides/img/model-version.png b/docs/docs/getting-started/img/model-version.png similarity index 100% rename from docs/docs/guides/img/model-version.png rename to docs/docs/getting-started/img/model-version.png diff --git a/docs/docs/guides/img/set-up.png b/docs/docs/getting-started/img/set-up.png similarity index 100% rename from docs/docs/guides/img/set-up.png rename to docs/docs/getting-started/img/set-up.png diff --git a/docs/docs/guides/img/start-model.png b/docs/docs/getting-started/img/start-model.png similarity index 100% rename from docs/docs/guides/img/start-model.png rename to docs/docs/getting-started/img/start-model.png diff --git a/docs/docs/guides/img/window-defender.png b/docs/docs/getting-started/img/window-defender.png similarity index 100% rename from docs/docs/guides/img/window-defender.png rename to docs/docs/getting-started/img/window-defender.png diff --git a/docs/docs/guides/install/linux.md b/docs/docs/getting-started/install/linux.md similarity index 100% rename from docs/docs/guides/install/linux.md rename to docs/docs/getting-started/install/linux.md diff --git a/docs/docs/guides/install/mac.md b/docs/docs/getting-started/install/mac.md similarity index 100% rename from docs/docs/guides/install/mac.md rename to docs/docs/getting-started/install/mac.md diff --git a/docs/docs/guides/install/windows.md b/docs/docs/getting-started/install/windows.md similarity index 100% rename from docs/docs/guides/install/windows.md rename to docs/docs/getting-started/install/windows.md diff --git a/docs/docs/guides/troubleshooting.md b/docs/docs/getting-started/troubleshooting.md similarity index 100% rename from docs/docs/guides/troubleshooting.md rename to docs/docs/getting-started/troubleshooting.md diff --git a/docs/docs/guides/overview.md b/docs/docs/guides/overview.md deleted file mode 100644 index bf44ca685..000000000 --- a/docs/docs/guides/overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Overview -slug: /guides ---- -- Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac, or even a Server that comes with extensibilities, toolbox, and state-of-the-art but optimized models for next-gen Apps. -- Jan App: Next-gen App built on Jan Plaform as `portable intelligence` that can be run everywhere. -- Models: - - Large Language Models - - Stable Diffusion models diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index df522ffb0..f669a70a1 100644 --- 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 index ea6a22a71..f3accdb77 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,39 +29,52 @@ const sidebars = { }, ], - guidesSidebar: [ - "guides/overview", - { - type: "category", - label: "Installation", - collapsible: true, - collapsed: false, - items: [ - { - type: "autogenerated", - dirName: "guides/install", - }, - ], - }, - "guides/troubleshooting", - ], - docsSidebar: [ - "docs/introduction", - "docs/quickstart", { type: "category", - label: "Modules", + label: "Getting Started", collapsible: true, collapsed: false, items: [ + "docs/introduction", { - type: "autogenerated", - dirName: "docs/modules", + type: "category", + label: "Installation", + collapsible: true, + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "getting-started/install", + }, + ], + }, + "docs/quickstart", + ], + }, + { + type: "category", + label: "Building Jan", + collapsible: false, + collapsed: false, + items: [ + "docs/user-interface", + { + 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: [ From 9ce5ed3991b407db2b58b4429fc737519c6c5a03 Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Wed, 15 Nov 2023 17:34:17 +0800 Subject: [PATCH 2/2] Disable collapsible on sidebar --- docs/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index f3accdb77..7736b60eb 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -33,7 +33,7 @@ const sidebars = { { type: "category", label: "Getting Started", - collapsible: true, + collapsible: false, collapsed: false, items: [ "docs/introduction",