From 24d2bfb6096b7bc0b0d20ae4df39a3bf720c55c2 Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Thu, 23 Nov 2023 23:22:36 +0800 Subject: [PATCH] Refactor Jan Site Structure --- docs/docs/community/community.md | 5 ++ docs/docs/specs/home.md | 3 + docs/docs/specs/hub.md | 3 + docs/docs/specs/system-monitor.md | 3 + docs/docusaurus.config.js | 22 +++++- docs/sidebars.js | 110 ++++++++++++++++++------------ 6 files changed, 99 insertions(+), 47 deletions(-) create mode 100644 docs/docs/community/community.md create mode 100644 docs/docs/specs/home.md create mode 100644 docs/docs/specs/hub.md create mode 100644 docs/docs/specs/system-monitor.md diff --git a/docs/docs/community/community.md b/docs/docs/community/community.md new file mode 100644 index 000000000..d6807f38a --- /dev/null +++ b/docs/docs/community/community.md @@ -0,0 +1,5 @@ +--- +title: Community +--- + +- [ ] Social media links \ No newline at end of file diff --git a/docs/docs/specs/home.md b/docs/docs/specs/home.md new file mode 100644 index 000000000..6e6ba714a --- /dev/null +++ b/docs/docs/specs/home.md @@ -0,0 +1,3 @@ +--- +title: Home +--- \ No newline at end of file diff --git a/docs/docs/specs/hub.md b/docs/docs/specs/hub.md new file mode 100644 index 000000000..16a7d639d --- /dev/null +++ b/docs/docs/specs/hub.md @@ -0,0 +1,3 @@ +--- +title: Hub +--- \ No newline at end of file diff --git a/docs/docs/specs/system-monitor.md b/docs/docs/specs/system-monitor.md new file mode 100644 index 000000000..cf4a2b22f --- /dev/null +++ b/docs/docs/specs/system-monitor.md @@ -0,0 +1,3 @@ +--- +title: System Monitor +--- \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index ad02d83c9..b32a959b0 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -141,16 +141,34 @@ const config = { // Navbar Left { type: "docSidebar", - sidebarId: "docsSidebar", + sidebarId: "guidesSidebar", position: "left", - label: "Documentation", + label: "Guides", + }, + { + type: "docSidebar", + sidebarId: "developerSidebar", + position: "left", + label: "Developer", }, { position: "left", to: "/api-reference", label: "API Reference", }, + { + type: "docSidebar", + position: "left", + sidebarId: "specsSidebar", + label: "Specs", + }, // Navbar right + { + type: "docSidebar", + position: "right", + sidebarId: "communitySidebar", + label: "Community", + }, { to: "blog", label: "Blog", diff --git a/docs/sidebars.js b/docs/sidebars.js index 035e51bd0..c534931af 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -13,7 +13,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - docsSidebar: [ + guidesSidebar: [ { type: "category", label: "Introduction", @@ -42,43 +42,14 @@ const sidebars = { collapsed: true, items: ["docs/models", "docs/server"], }, - { - type: "category", - label: "Extending Jan", - link: { type: "doc", id: "docs/extensions" }, - collapsible: true, - collapsed: true, - items: ["docs/assistants", "docs/themes", "docs/tools", "docs/modules"], - }, - { - type: "category", - label: "Building Jan", - collapsible: true, - collapsed: true, - items: [ - "specs/architecture", - "specs/data-structures", - "specs/user-interface", - { - type: "category", - label: "Specifications", - collapsible: true, - collapsed: false, - items: [ - "specs/chats", - "specs/models", - "specs/threads", - "specs/messages", - // "specs/assistants", - // "specs/files", - // "specs/jan", - // "specs/fine-tuning", - // "specs/settings", - // "specs/prompts", - ], - }, - ], - }, + ], + + developerSidebar: [ + "docs/extensions", + "docs/assistants", + "docs/themes", + "docs/tools", + "docs/modules", ], apiSidebar: [ @@ -97,17 +68,53 @@ const sidebars = { }, ], - aboutSidebar: [ + specsSidebar: [ { - type: "doc", - label: "About Jan", - id: "about/about", + type: "category", + label: "Overview", + collapsible: true, + collapsed: false, + items: [ + "specs/architecture", + "specs/data-structures", + "specs/user-interface", + ], }, { - type: "link", - label: "Careers", - href: "https://janai.bamboohr.com/careers", + type: "category", + label: "Product", + collapsible: true, + collapsed: false, + items: [ + "specs/home", + "specs/hub", + "specs/system-monitor", + "specs/settings", + ], }, + + { + type: "category", + label: "Engineering", + collapsible: true, + collapsed: false, + items: [ + "specs/chats", + "specs/models", + "specs/threads", + "specs/messages", + // "specs/assistants", + // "specs/files", + // "specs/jan", + // "specs/fine-tuning", + // "specs/settings", + // "specs/prompts", + ], + }, + ], + + communitySidebar: [ + "community/community", { type: "category", label: "Events", @@ -122,6 +129,19 @@ const sidebars = { }, ], }, + ], + + aboutSidebar: [ + { + type: "doc", + label: "About Jan", + id: "about/about", + }, + { + type: "link", + label: "Careers", + href: "https://janai.bamboohr.com/careers", + }, { type: "category", label: "Company Handbook",