Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Scaffold Docs Site Structure

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/docs/about/05-community/README.md → docs/docs/community/community.md
View File

3
docs/docs/community/contributor-program.md Normal file
View File

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

9
docs/docs/docs/02-integrations/README.md
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)

3
docs/docs/ecosystem/ecosystem.md Normal file
View File

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

0
docs/docs/about/05-community/events/README.mdx → docs/docs/events/README.mdx
View File

0
docs/docs/about/05-community/events/hcmc-oct23.md → docs/docs/events/hcmc-oct23.md
View File

0
docs/docs/about/05-community/events/nvidia-llm-day-nov-23.md → docs/docs/events/nvidia-llm-day-nov-23.md
View File

3
docs/docs/features/agents-framework.md Normal file
View File

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

3
docs/docs/features/api-server.md Normal file
View File

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

3
docs/docs/features/data-security.md Normal file
View File

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

3
docs/docs/features/extensions-framework.md Normal file
View File

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

3
docs/docs/features/local.md Normal file
View File

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

3
docs/docs/features/offline.md Normal file
View File

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

3
docs/docs/features/remote.md Normal file
View File

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

0
docs/docs/foundry/foundry.md Normal file
View File

3
docs/docs/integrations.md Normal file
View File

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

0
docs/docs/docs/02-integrations/langchain.md → docs/docs/integrations/langchain.md
View File

2
docs/docs/docs/02-integrations/llamacpp.md → docs/docs/integrations/llamacpp.md
View File

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

0
docs/docs/docs/02-integrations/ollama.md → docs/docs/integrations/ollama.md
View File

0
docs/docs/docs/02-integrations/openai.md → docs/docs/integrations/openai.md
View File

0
docs/docs/docs/02-integrations/openrouter.md → docs/docs/integrations/openrouter.md
View File

0
docs/docs/docs/02-integrations/tensorrt.md → docs/docs/integrations/tensorrt.md
View File

3
docs/docs/partners/partners.md Normal file
View File

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

4
docs/docs/pricing/pricing.md Normal file
View File

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

16
docs/docs/products/desktop.md Normal file
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,
]
---

3
docs/docs/products/hub.md Normal file
View File

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

16
docs/docs/products/mobile.md Normal file
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,
]
---

3
docs/docs/server-suite/admin-console.md Normal file
View File

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

3
docs/docs/server-suite/audit-compliance.md Normal file
View File

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

3
docs/docs/server-suite/identity-access-management.md Normal file
View File

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

3
docs/docs/server-suite/observability.md Normal file
View File

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

16
docs/docs/server-suite/server-suite.md Normal file
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,
]
---

3
docs/docs/solutions/audiences/consultants.md Normal file
View File

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

3
docs/docs/solutions/audiences/developers.md Normal file
View File

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

3
docs/docs/solutions/audiences/enterprises.md Normal file
View File

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

3
docs/docs/solutions/audiences/startups.md Normal file
View File

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

3
docs/docs/solutions/sectors/finance.md Normal file
View File

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

0
docs/docs/solutions/sectors/government.md Normal file
View File

3
docs/docs/solutions/sectors/healthcare.md Normal file
View File

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

0
docs/docs/solutions/sectors/legal.md Normal file
View File

3
docs/docs/solutions/use-cases/ai-employees.md Normal file
View File

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

3
docs/docs/solutions/use-cases/enterprise-search.md Normal file
View File

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

3
docs/docs/solutions/use-cases/personal-ai.md Normal file
View File

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

0
docs/docs/studio/studio.md Normal file
View File

58
docs/docusaurus.config.js
View File

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

101
docs/sidebars.js
View File

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