Scaffold Docs Site Structure

This commit is contained in:
Daniel 2024-02-06 20:50:42 +08:00
parent ee5a44a799
commit d6cfc3f07a
46 changed files with 273 additions and 24 deletions

View File

@ -0,0 +1,3 @@
---
title: Contributor Program
---

View File

@ -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)

View File

@ -0,0 +1,3 @@
---
title: Ecosystem
---

View File

@ -0,0 +1,3 @@
---
title: Agents Framework
---

View File

@ -0,0 +1,3 @@
---
title: API Server
---

View File

@ -0,0 +1,3 @@
---
title: Data Security
---

View File

@ -0,0 +1,3 @@
---
title: Extensions Framework
---

View File

@ -0,0 +1,3 @@
---
title: Local & Self-Hosted AI
---

View File

@ -0,0 +1,3 @@
---
title: Offline AI
---

View File

@ -0,0 +1,3 @@
---
title: Cloud-based AI
---

View File

View File

@ -0,0 +1,3 @@
---
title: Integrations
---

View File

@ -1,5 +1,5 @@
--- ---
title: LlamaCPP title: llama.cpp
--- ---
## Quicklinks ## Quicklinks

View File

@ -0,0 +1,3 @@
---
title: Partners
---

View File

@ -0,0 +1,4 @@
---
title: Pricing
slug: /pricing
---

View File

@ -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,
]
---

View File

@ -0,0 +1,3 @@
---
title: Jan Hub
---

View File

@ -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,
]
---

View File

@ -0,0 +1,3 @@
---
title: Admin Console
---

View File

@ -0,0 +1,3 @@
---
title: Audit & Compliance
---

View File

@ -0,0 +1,3 @@
---
title: Identity & Access Control
---

View File

@ -0,0 +1,3 @@
---
title: Observability
---

View File

@ -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,
]
---

View File

@ -0,0 +1,3 @@
---
title: Consultants
---

View File

@ -0,0 +1,3 @@
---
title: Developers
---

View File

@ -0,0 +1,3 @@
---
title: Enterprises
---

View File

@ -0,0 +1,3 @@
---
title: Startups
---

View File

@ -0,0 +1,3 @@
---
title: Finance
---

View File

@ -0,0 +1,3 @@
---
title: Healthcare
---

View File

View File

@ -0,0 +1,3 @@
---
title: AI Employees
---

View File

@ -0,0 +1,3 @@
---
title: Enterprise Search & Knowledge Management
---

View File

@ -0,0 +1,3 @@
---
title: Personal AI
---

View File

View File

@ -241,33 +241,63 @@ const config = {
// Navbar Left // Navbar Left
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "guidesSidebar", sidebarId: "productSidebar",
position: "left", positionL: "left",
label: "Guides", label: "Products",
}, },
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "developerSidebar", sidebarId: "solutionSidebar",
position: "left", positionL: "left",
label: "Developer", label: "Solutions",
},
{
position: "left",
to: "/api-reference",
label: "API Reference",
}, },
{ {
type: "docSidebar", type: "docSidebar",
position: "left", sidebarId: "ecosystemSidebar",
sidebarId: "docsSidebar", positionL: "left",
label: "Framework", 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 // Navbar right
{ {
to: "blog", to: "blog",
label: "Blog", label: "Blog",
position: "right", position: "right",
}, },
{
type: "docSidebar",
sidebarId: "partnerSidebar",
position: "right",
label: "Partners",
},
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "aboutSidebar", sidebarId: "aboutSidebar",

View File

@ -13,6 +13,107 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = { 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: [ guidesSidebar: [
{ {
type: "autogenerated", type: "autogenerated",