diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md deleted file mode 100644 index fea0b0c0b..000000000 --- a/docs/docs/about/about.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: About Jan -slug: /about ---- - -## Problem - -## Ideal Customer Persona - -## Business Model \ No newline at end of file diff --git a/docs/docs/about/brand-assets.md b/docs/docs/about/brand-assets.md deleted file mode 100644 index 3566f6256..000000000 --- a/docs/docs/about/brand-assets.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Brand Assets ---- diff --git a/docs/docs/about/team.md b/docs/docs/about/team.md deleted file mode 100644 index 492a7dce7..000000000 --- a/docs/docs/about/team.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Team ---- - diff --git a/docs/docs/docs/articles/nitro.md b/docs/docs/articles/nitro.md similarity index 100% rename from docs/docs/docs/articles/nitro.md rename to docs/docs/articles/nitro.md diff --git a/docs/docs/changelog/README.md b/docs/docs/changelog/README.md deleted file mode 100644 index 9ba595391..000000000 --- a/docs/docs/changelog/README.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 -title: Changelog ---- - -TODO \ No newline at end of file diff --git a/docs/docs/docs/docs.md b/docs/docs/docs/docs.md deleted file mode 100644 index ed1a5cd97..000000000 --- a/docs/docs/docs/docs.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 -title: Getting Started ---- - -TODO \ No newline at end of file diff --git a/docs/docs/docs/install/linux.md b/docs/docs/guides/linux.md similarity index 100% rename from docs/docs/docs/install/linux.md rename to docs/docs/guides/linux.md diff --git a/docs/docs/docs/install/mac.md b/docs/docs/guides/mac.md similarity index 100% rename from docs/docs/docs/install/mac.md rename to docs/docs/guides/mac.md diff --git a/docs/docs/docs/install/windows.md b/docs/docs/guides/windows.md similarity index 100% rename from docs/docs/docs/install/windows.md rename to docs/docs/guides/windows.md diff --git a/docs/docs/guides/community.md b/docs/docs/hardware/community.md similarity index 100% rename from docs/docs/guides/community.md rename to docs/docs/hardware/community.md diff --git a/docs/docs/guides/concepts/chassis.md b/docs/docs/hardware/concepts/chassis.md similarity index 100% rename from docs/docs/guides/concepts/chassis.md rename to docs/docs/hardware/concepts/chassis.md diff --git a/docs/docs/guides/concepts/concepts-images/GPU.png b/docs/docs/hardware/concepts/concepts-images/GPU.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/GPU.png rename to docs/docs/hardware/concepts/concepts-images/GPU.png diff --git a/docs/docs/guides/concepts/concepts-images/GPU_Image.png b/docs/docs/hardware/concepts/concepts-images/GPU_Image.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/GPU_Image.png rename to docs/docs/hardware/concepts/concepts-images/GPU_Image.png diff --git a/docs/docs/guides/concepts/concepts-images/PCIex16.png b/docs/docs/hardware/concepts/concepts-images/PCIex16.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/PCIex16.png rename to docs/docs/hardware/concepts/concepts-images/PCIex16.png diff --git a/docs/docs/guides/concepts/concepts-images/Power.png b/docs/docs/hardware/concepts/concepts-images/Power.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/Power.png rename to docs/docs/hardware/concepts/concepts-images/Power.png diff --git a/docs/docs/guides/concepts/concepts-images/RAM-VRAM.png b/docs/docs/hardware/concepts/concepts-images/RAM-VRAM.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/RAM-VRAM.png rename to docs/docs/hardware/concepts/concepts-images/RAM-VRAM.png diff --git a/docs/docs/guides/concepts/concepts-images/VRAM-Image.png b/docs/docs/hardware/concepts/concepts-images/VRAM-Image.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/VRAM-Image.png rename to docs/docs/hardware/concepts/concepts-images/VRAM-Image.png diff --git a/docs/docs/guides/concepts/concepts-images/slot.png b/docs/docs/hardware/concepts/concepts-images/slot.png similarity index 100% rename from docs/docs/guides/concepts/concepts-images/slot.png rename to docs/docs/hardware/concepts/concepts-images/slot.png diff --git a/docs/docs/guides/concepts/concepts.md b/docs/docs/hardware/concepts/concepts.md similarity index 100% rename from docs/docs/guides/concepts/concepts.md rename to docs/docs/hardware/concepts/concepts.md diff --git a/docs/docs/guides/concepts/cpu-and-ram.md b/docs/docs/hardware/concepts/cpu-and-ram.md similarity index 100% rename from docs/docs/guides/concepts/cpu-and-ram.md rename to docs/docs/hardware/concepts/cpu-and-ram.md diff --git a/docs/docs/guides/concepts/gpu-and-vram.md b/docs/docs/hardware/concepts/gpu-and-vram.md similarity index 100% rename from docs/docs/guides/concepts/gpu-and-vram.md rename to docs/docs/hardware/concepts/gpu-and-vram.md diff --git a/docs/docs/guides/concepts/motherboard.md b/docs/docs/hardware/concepts/motherboard.md similarity index 100% rename from docs/docs/guides/concepts/motherboard.md rename to docs/docs/hardware/concepts/motherboard.md diff --git a/docs/docs/guides/concepts/network.md b/docs/docs/hardware/concepts/network.md similarity index 100% rename from docs/docs/guides/concepts/network.md rename to docs/docs/hardware/concepts/network.md diff --git a/docs/docs/guides/concepts/power.md b/docs/docs/hardware/concepts/power.md similarity index 100% rename from docs/docs/guides/concepts/power.md rename to docs/docs/hardware/concepts/power.md diff --git a/docs/docs/guides/concepts/storage.md b/docs/docs/hardware/concepts/storage.md similarity index 100% rename from docs/docs/guides/concepts/storage.md rename to docs/docs/hardware/concepts/storage.md diff --git a/docs/docs/guides/examples/4090x2-@dan-jan.md b/docs/docs/hardware/examples/4090x2-@dan-jan.md similarity index 100% rename from docs/docs/guides/examples/4090x2-@dan-jan.md rename to docs/docs/hardware/examples/4090x2-@dan-jan.md diff --git a/docs/docs/guides/examples/_category_.json b/docs/docs/hardware/examples/_category_.json similarity index 100% rename from docs/docs/guides/examples/_category_.json rename to docs/docs/hardware/examples/_category_.json diff --git a/docs/docs/guides/hardware.md b/docs/docs/hardware/hardware.md similarity index 100% rename from docs/docs/guides/hardware.md rename to docs/docs/hardware/hardware.md diff --git a/docs/docs/guides/overview/cloud-vs-self-hosting.md b/docs/docs/hardware/overview/cloud-vs-self-hosting.md similarity index 100% rename from docs/docs/guides/overview/cloud-vs-self-hosting.md rename to docs/docs/hardware/overview/cloud-vs-self-hosting.md diff --git a/docs/docs/guides/overview/cpu-vs-gpu.md b/docs/docs/hardware/overview/cpu-vs-gpu.md similarity index 100% rename from docs/docs/guides/overview/cpu-vs-gpu.md rename to docs/docs/hardware/overview/cpu-vs-gpu.md diff --git a/docs/docs/guides/recommendations/by-budget.md b/docs/docs/hardware/recommendations/by-budget.md similarity index 100% rename from docs/docs/guides/recommendations/by-budget.md rename to docs/docs/hardware/recommendations/by-budget.md diff --git a/docs/docs/guides/recommendations/by-hardware.md b/docs/docs/hardware/recommendations/by-hardware.md similarity index 100% rename from docs/docs/guides/recommendations/by-hardware.md rename to docs/docs/hardware/recommendations/by-hardware.md diff --git a/docs/docs/guides/recommendations/by-model.md b/docs/docs/hardware/recommendations/by-model.md similarity index 100% rename from docs/docs/guides/recommendations/by-model.md rename to docs/docs/hardware/recommendations/by-model.md diff --git a/docs/docs/guides/recommendations/by-usecase.md b/docs/docs/hardware/recommendations/by-usecase.md similarity index 100% rename from docs/docs/guides/recommendations/by-usecase.md rename to docs/docs/hardware/recommendations/by-usecase.md diff --git a/docs/docs/docs/overview/app_anatomy.md b/docs/docs/overview/app_anatomy.md similarity index 60% rename from docs/docs/docs/overview/app_anatomy.md rename to docs/docs/overview/app_anatomy.md index 1b578d262..82a07191c 100644 --- a/docs/docs/docs/overview/app_anatomy.md +++ b/docs/docs/overview/app_anatomy.md @@ -1,16 +1,17 @@ --- -sidebar_position: 1 +sidebar_position: 3 title: App Anatomy --- Platform has 3 events that are broadcast to installed Apps ![Platform events](img/app-anatomy-4.drawio.png) + - onLaunch() -![Platform onLaunch()](img/app-anatomy-1.drawio.png) + ![Platform onLaunch()](img/app-anatomy-1.drawio.png) - onStart() -![Platform onStart()](img/app-anatomy-2.drawio.png) + ![Platform onStart()](img/app-anatomy-2.drawio.png) - onDispose() -![Platform onDispose()](img/app-anatomy-3.drawio.png) + ![Platform onDispose()](img/app-anatomy-3.drawio.png) - At any given time, when there is new App installtion/ unintallation, the Platform restarts and trigger - When App is being used, here is how the information passes between Platform and Apps -![Communication](img/app-anatomy-5.drawio.png) \ No newline at end of file + ![Communication](img/app-anatomy-5.drawio.png) diff --git a/docs/docs/docs/overview/architecture.md b/docs/docs/overview/architecture.md similarity index 100% rename from docs/docs/docs/overview/architecture.md rename to docs/docs/overview/architecture.md diff --git a/docs/docs/docs/overview/concepts.md b/docs/docs/overview/concepts.md similarity index 90% rename from docs/docs/docs/overview/concepts.md rename to docs/docs/overview/concepts.md index bc93f6081..a3b5a1551 100644 --- a/docs/docs/docs/overview/concepts.md +++ b/docs/docs/overview/concepts.md @@ -1,11 +1,12 @@ --- -sidebar_position: 1 +sidebar_position: 2 title: Concepts --- ## Concepts + - Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac or even Server that comes with extensibilities, toolbox and state of the art but optimized models for next gen App. - Jan App: Next gen App built on Jan Plaform as `portable intelligence` that can be run everywhere. - Models: - LLM models - - Other models \ No newline at end of file + - Other models diff --git a/docs/docs/docs/overview/img/app-anatomy-1.drawio.png b/docs/docs/overview/img/app-anatomy-1.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/app-anatomy-1.drawio.png rename to docs/docs/overview/img/app-anatomy-1.drawio.png diff --git a/docs/docs/docs/overview/img/app-anatomy-2.drawio.png b/docs/docs/overview/img/app-anatomy-2.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/app-anatomy-2.drawio.png rename to docs/docs/overview/img/app-anatomy-2.drawio.png diff --git a/docs/docs/docs/overview/img/app-anatomy-3.drawio.png b/docs/docs/overview/img/app-anatomy-3.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/app-anatomy-3.drawio.png rename to docs/docs/overview/img/app-anatomy-3.drawio.png diff --git a/docs/docs/docs/overview/img/app-anatomy-4.drawio.png b/docs/docs/overview/img/app-anatomy-4.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/app-anatomy-4.drawio.png rename to docs/docs/overview/img/app-anatomy-4.drawio.png diff --git a/docs/docs/docs/overview/img/app-anatomy-5.drawio.png b/docs/docs/overview/img/app-anatomy-5.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/app-anatomy-5.drawio.png rename to docs/docs/overview/img/app-anatomy-5.drawio.png diff --git a/docs/docs/docs/overview/img/architecture-1.drawio.png b/docs/docs/overview/img/architecture-1.drawio.png similarity index 100% rename from docs/docs/docs/overview/img/architecture-1.drawio.png rename to docs/docs/overview/img/architecture-1.drawio.png diff --git a/docs/docs/platform/platform.md b/docs/docs/platform/platform.md deleted file mode 100644 index 11531572e..000000000 --- a/docs/docs/platform/platform.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 1 -title: Overview -slug: /platform ---- diff --git a/docs/docs/products/desktop.md b/docs/docs/products/desktop.md deleted file mode 100644 index 302e25a92..000000000 --- a/docs/docs/products/desktop.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Jan Desktop ---- \ No newline at end of file diff --git a/docs/docs/products/mobile.md b/docs/docs/products/mobile.md deleted file mode 100644 index dd84f9c0b..000000000 --- a/docs/docs/products/mobile.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Jan Mobile ---- \ No newline at end of file diff --git a/docs/docs/products/products.md b/docs/docs/products/products.md deleted file mode 100644 index c95072f26..000000000 --- a/docs/docs/products/products.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Products -slug: /product ---- \ No newline at end of file diff --git a/docs/docs/products/server.md b/docs/docs/products/server.md deleted file mode 100644 index 0ce36871a..000000000 --- a/docs/docs/products/server.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Jan Server ---- \ No newline at end of file diff --git a/docs/docs/docs/reference/coreservice.md b/docs/docs/reference/coreservice.md similarity index 100% rename from docs/docs/docs/reference/coreservice.md rename to docs/docs/reference/coreservice.md diff --git a/docs/docs/docs/reference/models_catalog.md b/docs/docs/reference/models_catalog.md similarity index 100% rename from docs/docs/docs/reference/models_catalog.md rename to docs/docs/reference/models_catalog.md diff --git a/docs/docs/docs/reference/plugins_catalog.md b/docs/docs/reference/plugins_catalog.md similarity index 100% rename from docs/docs/docs/reference/plugins_catalog.md rename to docs/docs/reference/plugins_catalog.md diff --git a/docs/docs/solutions/industries/education.md b/docs/docs/solutions/industries/education.md deleted file mode 100644 index 8f8b9a0a1..000000000 --- a/docs/docs/solutions/industries/education.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Education ---- \ No newline at end of file diff --git a/docs/docs/solutions/industries/finance.md b/docs/docs/solutions/industries/finance.md deleted file mode 100644 index 55663a756..000000000 --- a/docs/docs/solutions/industries/finance.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Finance ---- \ No newline at end of file diff --git a/docs/docs/solutions/industries/healthcare.md b/docs/docs/solutions/industries/healthcare.md deleted file mode 100644 index 368cefa52..000000000 --- a/docs/docs/solutions/industries/healthcare.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Healthcare ---- \ No newline at end of file diff --git a/docs/docs/solutions/industries/law.md b/docs/docs/solutions/industries/law.md deleted file mode 100644 index 772ec3739..000000000 --- a/docs/docs/solutions/industries/law.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Law ---- \ No newline at end of file diff --git a/docs/docs/solutions/industries/public-sector.md b/docs/docs/solutions/industries/public-sector.md deleted file mode 100644 index aec5dd5be..000000000 --- a/docs/docs/solutions/industries/public-sector.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Public Sector ---- \ No newline at end of file diff --git a/docs/docs/solutions/industries/software.md b/docs/docs/solutions/industries/software.md deleted file mode 100644 index 4afbce7e8..000000000 --- a/docs/docs/solutions/industries/software.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Software Engineering ---- \ No newline at end of file diff --git a/docs/docs/solutions/personal-ai.md b/docs/docs/solutions/personal-ai.md deleted file mode 100644 index f4d6dc387..000000000 --- a/docs/docs/solutions/personal-ai.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Personal AI ---- \ No newline at end of file diff --git a/docs/docs/solutions/self-hosted.md b/docs/docs/solutions/self-hosted.md deleted file mode 100644 index 227b09923..000000000 --- a/docs/docs/solutions/self-hosted.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Self-Hosted ChatGPT ---- \ No newline at end of file diff --git a/docs/docs/solutions/solutions.md b/docs/docs/solutions/solutions.md deleted file mode 100644 index 5cbb047a4..000000000 --- a/docs/docs/solutions/solutions.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Overview -slug: /solutions ---- \ No newline at end of file diff --git a/docs/docs/docs/tutorials/build-jan-app.md b/docs/docs/tutorials/build-jan-app.md similarity index 100% rename from docs/docs/docs/tutorials/build-jan-app.md rename to docs/docs/tutorials/build-jan-app.md diff --git a/docs/docs/docs/tutorials/build-rag-app.md b/docs/docs/tutorials/build-rag-app.md similarity index 100% rename from docs/docs/docs/tutorials/build-rag-app.md rename to docs/docs/tutorials/build-rag-app.md diff --git a/docs/docs/docs/tutorials/publish-jan-app.md b/docs/docs/tutorials/publish-jan-app.md similarity index 100% rename from docs/docs/docs/tutorials/publish-jan-app.md rename to docs/docs/tutorials/publish-jan-app.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 0ef7a4572..f55f96a2a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -124,12 +124,6 @@ const config = { // position: "left", // label: "Platform", // }, - // { - // type: "docSidebar", - // sidebarId: "solutionsSidebar", - // position: "left", - // label: "Solutions", - // }, { type: "docSidebar", sidebarId: "companySidebar", @@ -137,28 +131,18 @@ const config = { label: "Company", }, // Navbar right - // { - // type: "docSidebar", - // sidebarId: "guidesSidebar", - // position: "right", - // label: "Guides", - // }, { type: "docSidebar", - sidebarId: "docsSidebar", + sidebarId: "guidesSidebar", + position: "right", + label: "Guides", + }, + { + type: "docSidebar", + sidebarId: "devSidebar", position: "right", label: "Developer", }, - // { - // position: "right", - // label: "API", - // to: "/api", - // }, - // { - // href: "https://github.com/janhq/jan", - // label: "GitHub", - // position: "right", - // }, ], }, prism: { diff --git a/docs/sidebars.js b/docs/sidebars.js index 7eecda1e3..775d7fe05 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -4,7 +4,7 @@ - render a sidebar for each doc of that group - provide next/previous navigation - The sidebars can be generated from the filesystem, or explicitly defined here. + The sidebars are explicitly defined here. Create as many sidebars as you want. */ @@ -13,19 +13,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - // By default, Docusaurus generates a sidebar from the docs folder structure - - // But you can create a sidebar manually featuresSidebar: [ - "platform/platform", - { - type: "category", - label: "Products", - collapsible: true, - collapsed: false, - link: { type: "doc", id: "products/products" }, - items: ["products/desktop", "products/mobile", "products/server"], - }, { type: "category", label: "Features", @@ -41,33 +29,24 @@ const sidebars = { }, ], - // Note: Tab name is "Use Cases" - solutionsSidebar: [ - // "solutions/solutions", + // Autogenerate docs from /guides + guidesSidebar: [ { type: "category", - label: "Solutions", + label: "Guides", collapsible: true, - collapsed: false, - items: ["solutions/self-hosted", "solutions/personal-ai"], + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "guides", + }, + ], }, - // { - // type: "category", - // label: "Industries", - // collapsible: true, - // collapsed: false, - // items: [ - // "solutions/industries/software", - // "solutions/industries/education", - // "solutions/industries/law", - // "solutions/industries/public-sector", - // "solutions/industries/finance", - // "solutions/industries/healthcare", - // ], - // }, ], - docsSidebar: [ + // + devSidebar: [ { type: "category", label: "Overview", @@ -75,19 +54,8 @@ const sidebars = { collapsed: false, items: [ { - type: "doc", - label: "Architecture", - id: "docs/overview/architecture", - }, - { - type: "doc", - label: "Concepts", - id: "docs/overview/concepts", - }, - { - type: "doc", - label: "App Anatomy", - id: "docs/overview/app_anatomy", + type: "autogenerated", + dirName: "overview", }, ], }, @@ -98,19 +66,8 @@ const sidebars = { collapsed: false, items: [ { - type: "doc", - label: "@janhq/core", - id: "docs/reference/coreservice", - }, - { - type: "doc", - label: "@janhq/models", - id: "docs/reference/models_catalog", - }, - { - type: "doc", - label: "@janhq/plugins", - id: "docs/reference/plugins_catalog", + type: "autogenerated", + dirName: "reference", }, ], }, @@ -121,19 +78,8 @@ const sidebars = { collapsed: false, items: [ { - type: "doc", - label: "How to Build a Chat App", - id: "docs/tutorials/build-jan-app", - }, - { - type: "doc", - label: "How to Build a RAG App", - id: "docs/tutorials/build-rag-app", - }, - { - type: "doc", - label: "How to Publish Apps on Jan", - id: "docs/tutorials/publish-jan-app", + type: "autogenerated", + dirName: "tutorials", }, ], }, @@ -146,27 +92,12 @@ const sidebars = { { type: "doc", label: "Nitro", - id: "docs/articles/nitro", + id: "articles/nitro", }, ], }, ], - // guidesSidebar: [ - // { - // type: "category", - // label: "Overview", - // collapsible: true, - // collapsed: true, - // items: [ - // { - // type: "doc", - // label: "architecture", - // id: "docs/overview/architecture", - // }, - // ], - // }, - // ], companySidebar: [ // { // type: "category",