From 1fa17600ed06e3d48716c1fa1636f24df3e29892 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Wed, 25 Oct 2023 14:53:20 +0700 Subject: [PATCH] refactor: new devhub layout --- docs/docs/docs/articles/nitro.md | 6 + docs/docs/docs/overview/architecture.md | 6 + docs/docs/docs/overview/concepts.md | 0 docs/docs/docs/reference/coreservice.md | 0 docs/docs/docs/tutorials/build-jan-app.md | 6 + docs/docs/docs/tutorials/build-rag-app.md | 6 + docs/docs/docs/tutorials/publish-jan-app.md | 6 + docs/docs/{hardware => guides}/community.md | 0 .../{hardware => guides}/concepts/chassis.md | 0 .../concepts/concepts-images/GPU.png | Bin .../concepts/concepts-images/GPU_Image.png | Bin .../concepts/concepts-images/PCIex16.png | Bin .../concepts/concepts-images/Power.png | Bin .../concepts/concepts-images/RAM-VRAM.png | Bin .../concepts/concepts-images/VRAM-Image.png | Bin .../concepts/concepts-images/slot.png | Bin .../{hardware => guides}/concepts/concepts.md | 0 .../concepts/cpu-and-ram.md | 0 .../concepts/gpu-and-vram.md | 0 .../concepts/motherboard.md | 0 .../{hardware => guides}/concepts/network.md | 0 .../{hardware => guides}/concepts/power.md | 0 .../{hardware => guides}/concepts/storage.md | 0 .../examples/4090x2-@dan-jan.md | 0 .../examples/_category_.json | 0 docs/docs/{hardware => guides}/hardware.md | 0 .../overview/cloud-vs-self-hosting.md | 0 .../overview/cpu-vs-gpu.md | 0 .../recommendations/by-budget.md | 0 .../recommendations/by-hardware.md | 0 .../recommendations/by-model.md | 0 .../recommendations/by-usecase.md | 0 docs/docusaurus.config.js | 16 +- docs/sidebars.js | 178 +++++++----------- 34 files changed, 111 insertions(+), 113 deletions(-) create mode 100644 docs/docs/docs/articles/nitro.md create mode 100644 docs/docs/docs/overview/architecture.md create mode 100644 docs/docs/docs/overview/concepts.md create mode 100644 docs/docs/docs/reference/coreservice.md create mode 100644 docs/docs/docs/tutorials/build-jan-app.md create mode 100644 docs/docs/docs/tutorials/build-rag-app.md create mode 100644 docs/docs/docs/tutorials/publish-jan-app.md rename docs/docs/{hardware => guides}/community.md (100%) rename docs/docs/{hardware => guides}/concepts/chassis.md (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/GPU.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/GPU_Image.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/PCIex16.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/Power.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/RAM-VRAM.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/VRAM-Image.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts-images/slot.png (100%) rename docs/docs/{hardware => guides}/concepts/concepts.md (100%) rename docs/docs/{hardware => guides}/concepts/cpu-and-ram.md (100%) rename docs/docs/{hardware => guides}/concepts/gpu-and-vram.md (100%) rename docs/docs/{hardware => guides}/concepts/motherboard.md (100%) rename docs/docs/{hardware => guides}/concepts/network.md (100%) rename docs/docs/{hardware => guides}/concepts/power.md (100%) rename docs/docs/{hardware => guides}/concepts/storage.md (100%) rename docs/docs/{hardware => guides}/examples/4090x2-@dan-jan.md (100%) rename docs/docs/{hardware => guides}/examples/_category_.json (100%) rename docs/docs/{hardware => guides}/hardware.md (100%) rename docs/docs/{hardware => guides}/overview/cloud-vs-self-hosting.md (100%) rename docs/docs/{hardware => guides}/overview/cpu-vs-gpu.md (100%) rename docs/docs/{hardware => guides}/recommendations/by-budget.md (100%) rename docs/docs/{hardware => guides}/recommendations/by-hardware.md (100%) rename docs/docs/{hardware => guides}/recommendations/by-model.md (100%) rename docs/docs/{hardware => guides}/recommendations/by-usecase.md (100%) diff --git a/docs/docs/docs/articles/nitro.md b/docs/docs/docs/articles/nitro.md new file mode 100644 index 000000000..877a4c032 --- /dev/null +++ b/docs/docs/docs/articles/nitro.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +title: Nitro +--- + +TODO diff --git a/docs/docs/docs/overview/architecture.md b/docs/docs/docs/overview/architecture.md new file mode 100644 index 000000000..8146ba62b --- /dev/null +++ b/docs/docs/docs/overview/architecture.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +title: Architecture +--- + +TODO diff --git a/docs/docs/docs/overview/concepts.md b/docs/docs/docs/overview/concepts.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docs/docs/reference/coreservice.md b/docs/docs/docs/reference/coreservice.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docs/docs/tutorials/build-jan-app.md b/docs/docs/docs/tutorials/build-jan-app.md new file mode 100644 index 000000000..8ed0715fd --- /dev/null +++ b/docs/docs/docs/tutorials/build-jan-app.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +title: How to Build a Jan App +--- + +TODO diff --git a/docs/docs/docs/tutorials/build-rag-app.md b/docs/docs/docs/tutorials/build-rag-app.md new file mode 100644 index 000000000..5c14911e1 --- /dev/null +++ b/docs/docs/docs/tutorials/build-rag-app.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 2 +title: How to Build RAG App +--- + +TODO diff --git a/docs/docs/docs/tutorials/publish-jan-app.md b/docs/docs/docs/tutorials/publish-jan-app.md new file mode 100644 index 000000000..d4badf12c --- /dev/null +++ b/docs/docs/docs/tutorials/publish-jan-app.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 3 +title: How to Publish a Jan App +--- + +TODO diff --git a/docs/docs/hardware/community.md b/docs/docs/guides/community.md similarity index 100% rename from docs/docs/hardware/community.md rename to docs/docs/guides/community.md diff --git a/docs/docs/hardware/concepts/chassis.md b/docs/docs/guides/concepts/chassis.md similarity index 100% rename from docs/docs/hardware/concepts/chassis.md rename to docs/docs/guides/concepts/chassis.md diff --git a/docs/docs/hardware/concepts/concepts-images/GPU.png b/docs/docs/guides/concepts/concepts-images/GPU.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/GPU.png rename to docs/docs/guides/concepts/concepts-images/GPU.png diff --git a/docs/docs/hardware/concepts/concepts-images/GPU_Image.png b/docs/docs/guides/concepts/concepts-images/GPU_Image.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/GPU_Image.png rename to docs/docs/guides/concepts/concepts-images/GPU_Image.png diff --git a/docs/docs/hardware/concepts/concepts-images/PCIex16.png b/docs/docs/guides/concepts/concepts-images/PCIex16.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/PCIex16.png rename to docs/docs/guides/concepts/concepts-images/PCIex16.png diff --git a/docs/docs/hardware/concepts/concepts-images/Power.png b/docs/docs/guides/concepts/concepts-images/Power.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/Power.png rename to docs/docs/guides/concepts/concepts-images/Power.png diff --git a/docs/docs/hardware/concepts/concepts-images/RAM-VRAM.png b/docs/docs/guides/concepts/concepts-images/RAM-VRAM.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/RAM-VRAM.png rename to docs/docs/guides/concepts/concepts-images/RAM-VRAM.png diff --git a/docs/docs/hardware/concepts/concepts-images/VRAM-Image.png b/docs/docs/guides/concepts/concepts-images/VRAM-Image.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/VRAM-Image.png rename to docs/docs/guides/concepts/concepts-images/VRAM-Image.png diff --git a/docs/docs/hardware/concepts/concepts-images/slot.png b/docs/docs/guides/concepts/concepts-images/slot.png similarity index 100% rename from docs/docs/hardware/concepts/concepts-images/slot.png rename to docs/docs/guides/concepts/concepts-images/slot.png diff --git a/docs/docs/hardware/concepts/concepts.md b/docs/docs/guides/concepts/concepts.md similarity index 100% rename from docs/docs/hardware/concepts/concepts.md rename to docs/docs/guides/concepts/concepts.md diff --git a/docs/docs/hardware/concepts/cpu-and-ram.md b/docs/docs/guides/concepts/cpu-and-ram.md similarity index 100% rename from docs/docs/hardware/concepts/cpu-and-ram.md rename to docs/docs/guides/concepts/cpu-and-ram.md diff --git a/docs/docs/hardware/concepts/gpu-and-vram.md b/docs/docs/guides/concepts/gpu-and-vram.md similarity index 100% rename from docs/docs/hardware/concepts/gpu-and-vram.md rename to docs/docs/guides/concepts/gpu-and-vram.md diff --git a/docs/docs/hardware/concepts/motherboard.md b/docs/docs/guides/concepts/motherboard.md similarity index 100% rename from docs/docs/hardware/concepts/motherboard.md rename to docs/docs/guides/concepts/motherboard.md diff --git a/docs/docs/hardware/concepts/network.md b/docs/docs/guides/concepts/network.md similarity index 100% rename from docs/docs/hardware/concepts/network.md rename to docs/docs/guides/concepts/network.md diff --git a/docs/docs/hardware/concepts/power.md b/docs/docs/guides/concepts/power.md similarity index 100% rename from docs/docs/hardware/concepts/power.md rename to docs/docs/guides/concepts/power.md diff --git a/docs/docs/hardware/concepts/storage.md b/docs/docs/guides/concepts/storage.md similarity index 100% rename from docs/docs/hardware/concepts/storage.md rename to docs/docs/guides/concepts/storage.md diff --git a/docs/docs/hardware/examples/4090x2-@dan-jan.md b/docs/docs/guides/examples/4090x2-@dan-jan.md similarity index 100% rename from docs/docs/hardware/examples/4090x2-@dan-jan.md rename to docs/docs/guides/examples/4090x2-@dan-jan.md diff --git a/docs/docs/hardware/examples/_category_.json b/docs/docs/guides/examples/_category_.json similarity index 100% rename from docs/docs/hardware/examples/_category_.json rename to docs/docs/guides/examples/_category_.json diff --git a/docs/docs/hardware/hardware.md b/docs/docs/guides/hardware.md similarity index 100% rename from docs/docs/hardware/hardware.md rename to docs/docs/guides/hardware.md diff --git a/docs/docs/hardware/overview/cloud-vs-self-hosting.md b/docs/docs/guides/overview/cloud-vs-self-hosting.md similarity index 100% rename from docs/docs/hardware/overview/cloud-vs-self-hosting.md rename to docs/docs/guides/overview/cloud-vs-self-hosting.md diff --git a/docs/docs/hardware/overview/cpu-vs-gpu.md b/docs/docs/guides/overview/cpu-vs-gpu.md similarity index 100% rename from docs/docs/hardware/overview/cpu-vs-gpu.md rename to docs/docs/guides/overview/cpu-vs-gpu.md diff --git a/docs/docs/hardware/recommendations/by-budget.md b/docs/docs/guides/recommendations/by-budget.md similarity index 100% rename from docs/docs/hardware/recommendations/by-budget.md rename to docs/docs/guides/recommendations/by-budget.md diff --git a/docs/docs/hardware/recommendations/by-hardware.md b/docs/docs/guides/recommendations/by-hardware.md similarity index 100% rename from docs/docs/hardware/recommendations/by-hardware.md rename to docs/docs/guides/recommendations/by-hardware.md diff --git a/docs/docs/hardware/recommendations/by-model.md b/docs/docs/guides/recommendations/by-model.md similarity index 100% rename from docs/docs/hardware/recommendations/by-model.md rename to docs/docs/guides/recommendations/by-model.md diff --git a/docs/docs/hardware/recommendations/by-usecase.md b/docs/docs/guides/recommendations/by-usecase.md similarity index 100% rename from docs/docs/hardware/recommendations/by-usecase.md rename to docs/docs/guides/recommendations/by-usecase.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 8ffebf68b..0ef7a4572 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -139,16 +139,16 @@ const config = { // Navbar right // { // type: "docSidebar", - // sidebarId: "docsSidebar", + // sidebarId: "guidesSidebar", // position: "right", - // label: "Docs", - // }, - // { - // type: "docSidebar", - // sidebarId: "hardwareSidebar", - // position: "right", - // label: "Hardware", + // label: "Guides", // }, + { + type: "docSidebar", + sidebarId: "docsSidebar", + position: "right", + label: "Developer", + }, // { // position: "right", // label: "API", diff --git a/docs/sidebars.js b/docs/sidebars.js index 7dc7ab662..de0df38d1 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -68,127 +68,95 @@ const sidebars = { ], docsSidebar: [ - { type: "doc", label: "Getting Started", id: "docs/docs" }, { type: "category", - label: "Install", + label: "Overview", collapsible: true, collapsed: false, items: [ - { type: "doc", label: "Windows", id: "docs/install/windows" }, - { type: "doc", label: "Mac", id: "docs/install/mac" }, - { type: "doc", label: "Linux", id: "docs/install/linux" }, + { + type: "doc", + label: "Architecture", + id: "docs/overview/architecture", + }, + { + type: "doc", + label: "Concepts", + id: "docs/overview/concepts", + }, ], }, - ], - - hardwareSidebar: [ - // { - // type: "category", - // label: "Overview", - // collapsible: true, - // collapsed: true, - // link: { type: "doc", id: "hardware/hardware" }, - // items: [ - // { - // type: "doc", - // label: "Cloud vs. Self-Hosting", - // id: "hardware/overview/cloud-vs-self-hosting", - // }, - // { - // type: "doc", - // label: "CPUs vs. GPUs", - // id: "hardware/overview/cpu-vs-gpu", - // }, - // ], - // }, - // { - // type: "category", - // label: "Recommendations", - // collapsible: true, - // collapsed: false, - // items: [ - // { - // type: "doc", - // label: "By Hardware", - // id: "hardware/recommendations/by-hardware", - // }, - // { - // type: "doc", - // label: "By Budget", - // id: "hardware/recommendations/by-budget", - // }, - // { - // type: "doc", - // label: "By Model", - // id: "hardware/recommendations/by-model", - // }, - // { - // type: "doc", - // label: "By Use Case", - // id: "hardware/recommendations/by-usecase", - // }, - // ], - // }, - // { - // type: "category", - // label: "Anatomy of a Thinking Machine", - // collapsible: true, - // collapsed: true, - // link: { type: "doc", id: "hardware/concepts/concepts" }, - // items: [ - // { - // type: "doc", - // label: "Chassis", - // id: "hardware/concepts/chassis", - // }, - // { - // type: "doc", - // label: "Motherboard", - // id: "hardware/concepts/motherboard", - // }, - // { - // type: "doc", - // label: "CPU and RAM", - // id: "hardware/concepts/cpu-and-ram", - // }, - // { - // type: "doc", - // label: "GPU and VRAM", - // id: "hardware/concepts/gpu-and-vram", - // }, - // { - // type: "doc", - // label: "Storage", - // id: "hardware/concepts/storage", - // }, - // { - // type: "doc", - // label: "Network", - // id: "hardware/concepts/network", - // }, - - // { - // type: "doc", - // label: "Power Supply", - // id: "hardware/concepts/power", - // }, - // ], - // }, { type: "category", - label: "Hardware Examples", + label: "Reference", collapsible: true, - collapsed: true, - link: { type: "doc", id: "hardware/community" }, + collapsed: false, items: [ { - type: "autogenerated", - dirName: "hardware/examples", + type: "doc", + label: "@janhq/core", + id: "docs/reference/coreservice", + }, + { + type: "doc", + label: "@janhq/inference", + id: "docs/reference/coreservice", + }, + ], + }, + { + type: "category", + label: "Tutorials", + collapsible: true, + 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: "category", + label: "Articles", + collapsible: true, + collapsed: false, + items: [ + { + type: "doc", + label: "Nitro", + id: "docs/articles/nitro", }, ], }, ], + + // guidesSidebar: [ + // { + // type: "category", + // label: "Overview", + // collapsible: true, + // collapsed: true, + // items: [ + // { + // type: "doc", + // label: "architecture", + // id: "docs/overview/architecture", + // }, + // ], + // }, + // ], companySidebar: [ // { // type: "category",