From d6cfc3f07afcd6ab51739bbe0e8f809512e0c969 Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Tue, 6 Feb 2024 20:50:42 +0800 Subject: [PATCH] Scaffold Docs Site Structure --- .../README.md => community/community.md} | 0 docs/docs/community/contributor-program.md | 3 + docs/docs/docs/02-integrations/README.md | 9 -- docs/docs/ecosystem/ecosystem.md | 3 + .../05-community => }/events/README.mdx | 0 .../05-community => }/events/hcmc-oct23.md | 0 .../events/nvidia-llm-day-nov-23.md | 0 docs/docs/features/agents-framework.md | 3 + docs/docs/features/api-server.md | 3 + docs/docs/features/data-security.md | 3 + docs/docs/features/extensions-framework.md | 3 + docs/docs/features/local.md | 3 + docs/docs/features/offline.md | 3 + docs/docs/features/remote.md | 3 + docs/docs/foundry/foundry.md | 0 docs/docs/integrations.md | 3 + .../langchain.md | 0 .../llamacpp.md | 2 +- .../ollama.md | 0 .../openai.md | 0 .../openrouter.md | 0 .../tensorrt.md | 0 docs/docs/partners/partners.md | 3 + docs/docs/pricing/pricing.md | 4 + docs/docs/products/desktop.md | 16 +++ docs/docs/products/hub.md | 3 + docs/docs/products/mobile.md | 16 +++ docs/docs/server-suite/admin-console.md | 3 + docs/docs/server-suite/audit-compliance.md | 3 + .../identity-access-management.md | 3 + docs/docs/server-suite/observability.md | 3 + docs/docs/server-suite/server-suite.md | 16 +++ docs/docs/solutions/audiences/consultants.md | 3 + docs/docs/solutions/audiences/developers.md | 3 + docs/docs/solutions/audiences/enterprises.md | 3 + docs/docs/solutions/audiences/startups.md | 3 + docs/docs/solutions/sectors/finance.md | 3 + docs/docs/solutions/sectors/government.md | 0 docs/docs/solutions/sectors/healthcare.md | 3 + docs/docs/solutions/sectors/legal.md | 0 docs/docs/solutions/use-cases/ai-employees.md | 3 + .../solutions/use-cases/enterprise-search.md | 3 + docs/docs/solutions/use-cases/personal-ai.md | 3 + docs/docs/studio/studio.md | 0 docs/docusaurus.config.js | 58 +++++++--- docs/sidebars.js | 101 ++++++++++++++++++ 46 files changed, 273 insertions(+), 24 deletions(-) rename docs/docs/{about/05-community/README.md => community/community.md} (100%) create mode 100644 docs/docs/community/contributor-program.md delete mode 100644 docs/docs/docs/02-integrations/README.md create mode 100644 docs/docs/ecosystem/ecosystem.md rename docs/docs/{about/05-community => }/events/README.mdx (100%) rename docs/docs/{about/05-community => }/events/hcmc-oct23.md (100%) rename docs/docs/{about/05-community => }/events/nvidia-llm-day-nov-23.md (100%) create mode 100644 docs/docs/features/agents-framework.md create mode 100644 docs/docs/features/api-server.md create mode 100644 docs/docs/features/data-security.md create mode 100644 docs/docs/features/extensions-framework.md create mode 100644 docs/docs/features/local.md create mode 100644 docs/docs/features/offline.md create mode 100644 docs/docs/features/remote.md create mode 100644 docs/docs/foundry/foundry.md create mode 100644 docs/docs/integrations.md rename docs/docs/{docs/02-integrations => integrations}/langchain.md (100%) rename docs/docs/{docs/02-integrations => integrations}/llamacpp.md (94%) rename docs/docs/{docs/02-integrations => integrations}/ollama.md (100%) rename docs/docs/{docs/02-integrations => integrations}/openai.md (100%) rename docs/docs/{docs/02-integrations => integrations}/openrouter.md (100%) rename docs/docs/{docs/02-integrations => integrations}/tensorrt.md (100%) create mode 100644 docs/docs/partners/partners.md create mode 100644 docs/docs/pricing/pricing.md create mode 100644 docs/docs/products/desktop.md create mode 100644 docs/docs/products/hub.md create mode 100644 docs/docs/products/mobile.md create mode 100644 docs/docs/server-suite/admin-console.md create mode 100644 docs/docs/server-suite/audit-compliance.md create mode 100644 docs/docs/server-suite/identity-access-management.md create mode 100644 docs/docs/server-suite/observability.md create mode 100644 docs/docs/server-suite/server-suite.md create mode 100644 docs/docs/solutions/audiences/consultants.md create mode 100644 docs/docs/solutions/audiences/developers.md create mode 100644 docs/docs/solutions/audiences/enterprises.md create mode 100644 docs/docs/solutions/audiences/startups.md create mode 100644 docs/docs/solutions/sectors/finance.md create mode 100644 docs/docs/solutions/sectors/government.md create mode 100644 docs/docs/solutions/sectors/healthcare.md create mode 100644 docs/docs/solutions/sectors/legal.md create mode 100644 docs/docs/solutions/use-cases/ai-employees.md create mode 100644 docs/docs/solutions/use-cases/enterprise-search.md create mode 100644 docs/docs/solutions/use-cases/personal-ai.md create mode 100644 docs/docs/studio/studio.md diff --git a/docs/docs/about/05-community/README.md b/docs/docs/community/community.md similarity index 100% rename from docs/docs/about/05-community/README.md rename to docs/docs/community/community.md diff --git a/docs/docs/community/contributor-program.md b/docs/docs/community/contributor-program.md new file mode 100644 index 000000000..cacdfa047 --- /dev/null +++ b/docs/docs/community/contributor-program.md @@ -0,0 +1,3 @@ +--- +title: Contributor Program +--- \ No newline at end of file diff --git a/docs/docs/docs/02-integrations/README.md b/docs/docs/docs/02-integrations/README.md deleted file mode 100644 index a1fe45e0c..000000000 --- a/docs/docs/docs/02-integrations/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Integrations ---- - -Existing and upcoming 3rd party integrations on top of Jan Framework. - -From both the core development team, and core contributors. - -Suggestions? File an [issue here](https://github.com/janhq/jan/issues) diff --git a/docs/docs/ecosystem/ecosystem.md b/docs/docs/ecosystem/ecosystem.md new file mode 100644 index 000000000..38f939b3a --- /dev/null +++ b/docs/docs/ecosystem/ecosystem.md @@ -0,0 +1,3 @@ +--- +title: Ecosystem +--- \ No newline at end of file diff --git a/docs/docs/about/05-community/events/README.mdx b/docs/docs/events/README.mdx similarity index 100% rename from docs/docs/about/05-community/events/README.mdx rename to docs/docs/events/README.mdx diff --git a/docs/docs/about/05-community/events/hcmc-oct23.md b/docs/docs/events/hcmc-oct23.md similarity index 100% rename from docs/docs/about/05-community/events/hcmc-oct23.md rename to docs/docs/events/hcmc-oct23.md diff --git a/docs/docs/about/05-community/events/nvidia-llm-day-nov-23.md b/docs/docs/events/nvidia-llm-day-nov-23.md similarity index 100% rename from docs/docs/about/05-community/events/nvidia-llm-day-nov-23.md rename to docs/docs/events/nvidia-llm-day-nov-23.md diff --git a/docs/docs/features/agents-framework.md b/docs/docs/features/agents-framework.md new file mode 100644 index 000000000..2ba312854 --- /dev/null +++ b/docs/docs/features/agents-framework.md @@ -0,0 +1,3 @@ +--- +title: Agents Framework +--- \ No newline at end of file diff --git a/docs/docs/features/api-server.md b/docs/docs/features/api-server.md new file mode 100644 index 000000000..36f697cb2 --- /dev/null +++ b/docs/docs/features/api-server.md @@ -0,0 +1,3 @@ +--- +title: API Server +--- \ No newline at end of file diff --git a/docs/docs/features/data-security.md b/docs/docs/features/data-security.md new file mode 100644 index 000000000..c5c1e6c7c --- /dev/null +++ b/docs/docs/features/data-security.md @@ -0,0 +1,3 @@ +--- +title: Data Security +--- \ No newline at end of file diff --git a/docs/docs/features/extensions-framework.md b/docs/docs/features/extensions-framework.md new file mode 100644 index 000000000..6c173ee53 --- /dev/null +++ b/docs/docs/features/extensions-framework.md @@ -0,0 +1,3 @@ +--- +title: Extensions Framework +--- \ No newline at end of file diff --git a/docs/docs/features/local.md b/docs/docs/features/local.md new file mode 100644 index 000000000..6c80c0378 --- /dev/null +++ b/docs/docs/features/local.md @@ -0,0 +1,3 @@ +--- +title: Local & Self-Hosted AI +--- \ No newline at end of file diff --git a/docs/docs/features/offline.md b/docs/docs/features/offline.md new file mode 100644 index 000000000..8fa40265b --- /dev/null +++ b/docs/docs/features/offline.md @@ -0,0 +1,3 @@ +--- +title: Offline AI +--- \ No newline at end of file diff --git a/docs/docs/features/remote.md b/docs/docs/features/remote.md new file mode 100644 index 000000000..2cfe481bb --- /dev/null +++ b/docs/docs/features/remote.md @@ -0,0 +1,3 @@ +--- +title: Cloud-based AI +--- \ No newline at end of file diff --git a/docs/docs/foundry/foundry.md b/docs/docs/foundry/foundry.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docs/integrations.md b/docs/docs/integrations.md new file mode 100644 index 000000000..0884d2242 --- /dev/null +++ b/docs/docs/integrations.md @@ -0,0 +1,3 @@ +--- +title: Integrations +--- \ No newline at end of file diff --git a/docs/docs/docs/02-integrations/langchain.md b/docs/docs/integrations/langchain.md similarity index 100% rename from docs/docs/docs/02-integrations/langchain.md rename to docs/docs/integrations/langchain.md diff --git a/docs/docs/docs/02-integrations/llamacpp.md b/docs/docs/integrations/llamacpp.md similarity index 94% rename from docs/docs/docs/02-integrations/llamacpp.md rename to docs/docs/integrations/llamacpp.md index 9d5004982..2764187c1 100644 --- a/docs/docs/docs/02-integrations/llamacpp.md +++ b/docs/docs/integrations/llamacpp.md @@ -1,5 +1,5 @@ --- -title: LlamaCPP +title: llama.cpp --- ## Quicklinks diff --git a/docs/docs/docs/02-integrations/ollama.md b/docs/docs/integrations/ollama.md similarity index 100% rename from docs/docs/docs/02-integrations/ollama.md rename to docs/docs/integrations/ollama.md diff --git a/docs/docs/docs/02-integrations/openai.md b/docs/docs/integrations/openai.md similarity index 100% rename from docs/docs/docs/02-integrations/openai.md rename to docs/docs/integrations/openai.md diff --git a/docs/docs/docs/02-integrations/openrouter.md b/docs/docs/integrations/openrouter.md similarity index 100% rename from docs/docs/docs/02-integrations/openrouter.md rename to docs/docs/integrations/openrouter.md diff --git a/docs/docs/docs/02-integrations/tensorrt.md b/docs/docs/integrations/tensorrt.md similarity index 100% rename from docs/docs/docs/02-integrations/tensorrt.md rename to docs/docs/integrations/tensorrt.md diff --git a/docs/docs/partners/partners.md b/docs/docs/partners/partners.md new file mode 100644 index 000000000..1c5eaa0f2 --- /dev/null +++ b/docs/docs/partners/partners.md @@ -0,0 +1,3 @@ +--- +title: Partners +--- \ No newline at end of file diff --git a/docs/docs/pricing/pricing.md b/docs/docs/pricing/pricing.md new file mode 100644 index 000000000..3d8c7f27b --- /dev/null +++ b/docs/docs/pricing/pricing.md @@ -0,0 +1,4 @@ +--- +title: Pricing +slug: /pricing +--- \ No newline at end of file diff --git a/docs/docs/products/desktop.md b/docs/docs/products/desktop.md new file mode 100644 index 000000000..9e5818b5b --- /dev/null +++ b/docs/docs/products/desktop.md @@ -0,0 +1,16 @@ +--- +title: Jan Desktop +slug: /desktop +description: Turn your computer into an AI PC +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- \ No newline at end of file diff --git a/docs/docs/products/hub.md b/docs/docs/products/hub.md new file mode 100644 index 000000000..9d8167618 --- /dev/null +++ b/docs/docs/products/hub.md @@ -0,0 +1,3 @@ +--- +title: Jan Hub +--- \ No newline at end of file diff --git a/docs/docs/products/mobile.md b/docs/docs/products/mobile.md new file mode 100644 index 000000000..827544201 --- /dev/null +++ b/docs/docs/products/mobile.md @@ -0,0 +1,16 @@ +--- +title: Jan Mobile +slug: /mobile +description: Jan Mobile allows you to bring your AI on the go +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- \ No newline at end of file diff --git a/docs/docs/server-suite/admin-console.md b/docs/docs/server-suite/admin-console.md new file mode 100644 index 000000000..e2da5c096 --- /dev/null +++ b/docs/docs/server-suite/admin-console.md @@ -0,0 +1,3 @@ +--- +title: Admin Console +--- \ No newline at end of file diff --git a/docs/docs/server-suite/audit-compliance.md b/docs/docs/server-suite/audit-compliance.md new file mode 100644 index 000000000..af4684899 --- /dev/null +++ b/docs/docs/server-suite/audit-compliance.md @@ -0,0 +1,3 @@ +--- +title: Audit & Compliance +--- \ No newline at end of file diff --git a/docs/docs/server-suite/identity-access-management.md b/docs/docs/server-suite/identity-access-management.md new file mode 100644 index 000000000..bdeafa9bd --- /dev/null +++ b/docs/docs/server-suite/identity-access-management.md @@ -0,0 +1,3 @@ +--- +title: Identity & Access Control +--- \ No newline at end of file diff --git a/docs/docs/server-suite/observability.md b/docs/docs/server-suite/observability.md new file mode 100644 index 000000000..6371a6287 --- /dev/null +++ b/docs/docs/server-suite/observability.md @@ -0,0 +1,3 @@ +--- +title: Observability +--- \ No newline at end of file diff --git a/docs/docs/server-suite/server-suite.md b/docs/docs/server-suite/server-suite.md new file mode 100644 index 000000000..19417db2a --- /dev/null +++ b/docs/docs/server-suite/server-suite.md @@ -0,0 +1,16 @@ +--- +title: Jan Server Suite +slug: /server-suite +description: Built for Enterprise Deployments +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- \ No newline at end of file diff --git a/docs/docs/solutions/audiences/consultants.md b/docs/docs/solutions/audiences/consultants.md new file mode 100644 index 000000000..6fcedd342 --- /dev/null +++ b/docs/docs/solutions/audiences/consultants.md @@ -0,0 +1,3 @@ +--- +title: Consultants +--- \ No newline at end of file diff --git a/docs/docs/solutions/audiences/developers.md b/docs/docs/solutions/audiences/developers.md new file mode 100644 index 000000000..c43bb6b73 --- /dev/null +++ b/docs/docs/solutions/audiences/developers.md @@ -0,0 +1,3 @@ +--- +title: Developers +--- \ No newline at end of file diff --git a/docs/docs/solutions/audiences/enterprises.md b/docs/docs/solutions/audiences/enterprises.md new file mode 100644 index 000000000..6012fbe8d --- /dev/null +++ b/docs/docs/solutions/audiences/enterprises.md @@ -0,0 +1,3 @@ +--- +title: Enterprises +--- \ No newline at end of file diff --git a/docs/docs/solutions/audiences/startups.md b/docs/docs/solutions/audiences/startups.md new file mode 100644 index 000000000..08d7d2f56 --- /dev/null +++ b/docs/docs/solutions/audiences/startups.md @@ -0,0 +1,3 @@ +--- +title: Startups +--- \ No newline at end of file diff --git a/docs/docs/solutions/sectors/finance.md b/docs/docs/solutions/sectors/finance.md new file mode 100644 index 000000000..55663a756 --- /dev/null +++ b/docs/docs/solutions/sectors/finance.md @@ -0,0 +1,3 @@ +--- +title: Finance +--- \ No newline at end of file diff --git a/docs/docs/solutions/sectors/government.md b/docs/docs/solutions/sectors/government.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docs/solutions/sectors/healthcare.md b/docs/docs/solutions/sectors/healthcare.md new file mode 100644 index 000000000..368cefa52 --- /dev/null +++ b/docs/docs/solutions/sectors/healthcare.md @@ -0,0 +1,3 @@ +--- +title: Healthcare +--- \ No newline at end of file diff --git a/docs/docs/solutions/sectors/legal.md b/docs/docs/solutions/sectors/legal.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docs/solutions/use-cases/ai-employees.md b/docs/docs/solutions/use-cases/ai-employees.md new file mode 100644 index 000000000..149cc787a --- /dev/null +++ b/docs/docs/solutions/use-cases/ai-employees.md @@ -0,0 +1,3 @@ +--- +title: AI Employees +--- \ No newline at end of file diff --git a/docs/docs/solutions/use-cases/enterprise-search.md b/docs/docs/solutions/use-cases/enterprise-search.md new file mode 100644 index 000000000..b01eb6cbb --- /dev/null +++ b/docs/docs/solutions/use-cases/enterprise-search.md @@ -0,0 +1,3 @@ +--- +title: Enterprise Search & Knowledge Management +--- \ No newline at end of file diff --git a/docs/docs/solutions/use-cases/personal-ai.md b/docs/docs/solutions/use-cases/personal-ai.md new file mode 100644 index 000000000..f4d6dc387 --- /dev/null +++ b/docs/docs/solutions/use-cases/personal-ai.md @@ -0,0 +1,3 @@ +--- +title: Personal AI +--- \ No newline at end of file diff --git a/docs/docs/studio/studio.md b/docs/docs/studio/studio.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 4ed7f0bea..a874752d3 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -241,33 +241,63 @@ const config = { // Navbar Left { type: "docSidebar", - sidebarId: "guidesSidebar", - position: "left", - label: "Guides", + sidebarId: "productSidebar", + positionL: "left", + label: "Products", }, { type: "docSidebar", - sidebarId: "developerSidebar", - position: "left", - label: "Developer", - }, - { - position: "left", - to: "/api-reference", - label: "API Reference", + sidebarId: "solutionSidebar", + positionL: "left", + label: "Solutions", }, { type: "docSidebar", - position: "left", - sidebarId: "docsSidebar", - label: "Framework", + sidebarId: "ecosystemSidebar", + positionL: "left", + label: "Ecosystem", }, + { + type: "docSidebar", + sidebarId: "pricingSidebar", + positionL: "left", + label: "Pricing", + }, + // { + // type: "docSidebar", + // sidebarId: "guidesSidebar", + // position: "left", + // label: "Guides", + // }, + // { + // type: "docSidebar", + // sidebarId: "developerSidebar", + // position: "left", + // label: "Developer", + // }, + // { + // position: "left", + // to: "/api-reference", + // label: "API Reference", + // }, + // { + // type: "docSidebar", + // position: "left", + // sidebarId: "docsSidebar", + // label: "Framework", + // }, // Navbar right { to: "blog", label: "Blog", position: "right", }, + { + type: "docSidebar", + sidebarId: "partnerSidebar", + position: "right", + label: "Partners", + }, { type: "docSidebar", sidebarId: "aboutSidebar", diff --git a/docs/sidebars.js b/docs/sidebars.js index 00eb8d40d..c63a2962a 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -13,6 +13,107 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { + productSidebar: [ + { + type: "category", + label: "Products", + collapsible: false, + items: [ + "products/desktop", + "server-suite/server-suite", + "products/mobile", + "products/hub", + ], + }, + // NOTE: Jan Server Suite will be torn out into it's own section in the future + // { + // type: "category", + // label: "Jan Server Suite", + // link: { type: "doc", id: "server-suite/server-suite" }, + // items: [ + // "server-suite/admin-console", + // "server-suite/identity-access-management", + // "server-suite/audit-compliance", + // "server-suite/observability", + // ], + // }, + { + type: "category", + collapsible: true, + collapsed: true, + label: "Features", + items: [ + "features/local", + "features/remote", + "features/data-security", + "features/api-server", + "features/extensions-framework", + "features/agents-framework", + "features/offline", + ], + }, + ], + solutionSidebar: [ + { + type: "category", + label: "Use Cases", + collapsed: true, + collapsible: true, + items: [ + "solutions/use-cases/personal-ai", + "solutions/use-cases/ai-employees", + "solutions/use-cases/enterprise-search", + // "solutions/sectors/legal", + // "solutions/sectors/government", + ], + }, + { + type: "category", + label: "Sectors", + collapsed: true, + collapsible: true, + items: [ + "solutions/sectors/finance", + "solutions/sectors/healthcare", + // "solutions/sectors/legal", + // "solutions/sectors/government", + ], + }, + { + type: "category", + label: "Audiences", + collapsed: true, + collapsible: true, + items: [ + "solutions/audiences/developers", + "solutions/audiences/startups", + "solutions/audiences/enterprises", + "solutions/audiences/consultants", + ], + }, + ], + ecosystemSidebar: [ + "ecosystem/ecosystem", + { + type: "category", + label: "Community", + link: { type: "doc", id: "community/community" }, + items: ["community/contributor-program"], + }, + { + type: "category", + label: "Integrations", + link: { type: "doc", id: "integrations" }, + items: [ + { + type: "autogenerated", + dirName: "integrations", + }, + ], + }, + ], + pricingSidebar: ["pricing/pricing"], + partnerSidebar: ["partners/partners"], guidesSidebar: [ { type: "autogenerated",