refactor: docs url structure

This commit is contained in:
0xSage 2023-10-26 11:20:25 +07:00
parent b727c21568
commit 55eed4fe51
65 changed files with 36 additions and 194 deletions

View File

@ -1,10 +0,0 @@
---
title: About Jan
slug: /about
---
## Problem
## Ideal Customer Persona
## Business Model

View File

@ -1,3 +0,0 @@
---
title: Brand Assets
---

View File

@ -1,4 +0,0 @@
---
title: Team
---

View File

@ -1,6 +0,0 @@
---
sidebar_position: 1
title: Changelog
---
TODO

View File

@ -1,6 +0,0 @@
---
sidebar_position: 1
title: Getting Started
---
TODO

View File

Before

Width:  |  Height:  |  Size: 388 KiB

After

Width:  |  Height:  |  Size: 388 KiB

View File

Before

Width:  |  Height:  |  Size: 945 KiB

After

Width:  |  Height:  |  Size: 945 KiB

View File

Before

Width:  |  Height:  |  Size: 2.2 MiB

After

Width:  |  Height:  |  Size: 2.2 MiB

View File

Before

Width:  |  Height:  |  Size: 453 KiB

After

Width:  |  Height:  |  Size: 453 KiB

View File

Before

Width:  |  Height:  |  Size: 349 KiB

After

Width:  |  Height:  |  Size: 349 KiB

View File

Before

Width:  |  Height:  |  Size: 553 KiB

After

Width:  |  Height:  |  Size: 553 KiB

View File

Before

Width:  |  Height:  |  Size: 636 KiB

After

Width:  |  Height:  |  Size: 636 KiB

View File

@ -1,16 +1,17 @@
--- ---
sidebar_position: 1 sidebar_position: 3
title: App Anatomy title: App Anatomy
--- ---
Platform has 3 events that are broadcast to installed Apps Platform has 3 events that are broadcast to installed Apps
![Platform events](img/app-anatomy-4.drawio.png) ![Platform events](img/app-anatomy-4.drawio.png)
- onLaunch() - onLaunch()
![Platform onLaunch()](img/app-anatomy-1.drawio.png) ![Platform onLaunch()](img/app-anatomy-1.drawio.png)
- onStart() - onStart()
![Platform onStart()](img/app-anatomy-2.drawio.png) ![Platform onStart()](img/app-anatomy-2.drawio.png)
- onDispose() - onDispose()
![Platform onDispose()](img/app-anatomy-3.drawio.png) ![Platform onDispose()](img/app-anatomy-3.drawio.png)
- At any given time, when there is new App installtion/ unintallation, the Platform restarts and trigger - At any given time, when there is new App installtion/ unintallation, the Platform restarts and trigger
- When App is being used, here is how the information passes between Platform and Apps - When App is being used, here is how the information passes between Platform and Apps
![Communication](img/app-anatomy-5.drawio.png) ![Communication](img/app-anatomy-5.drawio.png)

View File

@ -1,11 +1,12 @@
--- ---
sidebar_position: 1 sidebar_position: 2
title: Concepts title: Concepts
--- ---
## Concepts ## Concepts
- Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac or even Server that comes with extensibilities, toolbox and state of the art but optimized models for next gen App. - Jan Platform: Desktop app/ Cloud native SaaS that can run on Linux, Windows, Mac or even Server that comes with extensibilities, toolbox and state of the art but optimized models for next gen App.
- Jan App: Next gen App built on Jan Plaform as `portable intelligence` that can be run everywhere. - Jan App: Next gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.
- Models: - Models:
- LLM models - LLM models
- Other models - Other models

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

@ -1,5 +0,0 @@
---
sidebar_position: 1
title: Overview
slug: /platform
---

View File

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

View File

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

View File

@ -1,4 +0,0 @@
---
title: Products
slug: /product
---

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,3 +0,0 @@
---
title: Public Sector
---

View File

@ -1,3 +0,0 @@
---
title: Software Engineering
---

View File

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

View File

@ -1,3 +0,0 @@
---
title: Self-Hosted ChatGPT
---

View File

@ -1,4 +0,0 @@
---
title: Overview
slug: /solutions
---

View File

@ -124,12 +124,6 @@ const config = {
// position: "left", // position: "left",
// label: "Platform", // label: "Platform",
// }, // },
// {
// type: "docSidebar",
// sidebarId: "solutionsSidebar",
// position: "left",
// label: "Solutions",
// },
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "companySidebar", sidebarId: "companySidebar",
@ -137,28 +131,18 @@ const config = {
label: "Company", label: "Company",
}, },
// Navbar right // Navbar right
// {
// type: "docSidebar",
// sidebarId: "guidesSidebar",
// position: "right",
// label: "Guides",
// },
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "docsSidebar", sidebarId: "guidesSidebar",
position: "right",
label: "Guides",
},
{
type: "docSidebar",
sidebarId: "devSidebar",
position: "right", position: "right",
label: "Developer", label: "Developer",
}, },
// {
// position: "right",
// label: "API",
// to: "/api",
// },
// {
// href: "https://github.com/janhq/jan",
// label: "GitHub",
// position: "right",
// },
], ],
}, },
prism: { prism: {

View File

@ -4,7 +4,7 @@
- render a sidebar for each doc of that group - render a sidebar for each doc of that group
- provide next/previous navigation - provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here. The sidebars are explicitly defined here.
Create as many sidebars as you want. Create as many sidebars as you want.
*/ */
@ -13,19 +13,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = { const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// But you can create a sidebar manually
featuresSidebar: [ featuresSidebar: [
"platform/platform",
{
type: "category",
label: "Products",
collapsible: true,
collapsed: false,
link: { type: "doc", id: "products/products" },
items: ["products/desktop", "products/mobile", "products/server"],
},
{ {
type: "category", type: "category",
label: "Features", label: "Features",
@ -41,33 +29,24 @@ const sidebars = {
}, },
], ],
// Note: Tab name is "Use Cases" // Autogenerate docs from /guides
solutionsSidebar: [ guidesSidebar: [
// "solutions/solutions",
{ {
type: "category", type: "category",
label: "Solutions", label: "Guides",
collapsible: true, collapsible: true,
collapsed: false, collapsed: true,
items: ["solutions/self-hosted", "solutions/personal-ai"], items: [
{
type: "autogenerated",
dirName: "guides",
},
],
}, },
// {
// type: "category",
// label: "Industries",
// collapsible: true,
// collapsed: false,
// items: [
// "solutions/industries/software",
// "solutions/industries/education",
// "solutions/industries/law",
// "solutions/industries/public-sector",
// "solutions/industries/finance",
// "solutions/industries/healthcare",
// ],
// },
], ],
docsSidebar: [ //
devSidebar: [
{ {
type: "category", type: "category",
label: "Overview", label: "Overview",
@ -75,19 +54,8 @@ const sidebars = {
collapsed: false, collapsed: false,
items: [ items: [
{ {
type: "doc", type: "autogenerated",
label: "Architecture", dirName: "overview",
id: "docs/overview/architecture",
},
{
type: "doc",
label: "Concepts",
id: "docs/overview/concepts",
},
{
type: "doc",
label: "App Anatomy",
id: "docs/overview/app_anatomy",
}, },
], ],
}, },
@ -98,19 +66,8 @@ const sidebars = {
collapsed: false, collapsed: false,
items: [ items: [
{ {
type: "doc", type: "autogenerated",
label: "@janhq/core", dirName: "reference",
id: "docs/reference/coreservice",
},
{
type: "doc",
label: "@janhq/models",
id: "docs/reference/models_catalog",
},
{
type: "doc",
label: "@janhq/plugins",
id: "docs/reference/plugins_catalog",
}, },
], ],
}, },
@ -121,19 +78,8 @@ const sidebars = {
collapsed: false, collapsed: false,
items: [ items: [
{ {
type: "doc", type: "autogenerated",
label: "How to Build a Chat App", dirName: "tutorials",
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",
}, },
], ],
}, },
@ -146,27 +92,12 @@ const sidebars = {
{ {
type: "doc", type: "doc",
label: "Nitro", label: "Nitro",
id: "docs/articles/nitro", id: "articles/nitro",
}, },
], ],
}, },
], ],
// guidesSidebar: [
// {
// type: "category",
// label: "Overview",
// collapsible: true,
// collapsed: true,
// items: [
// {
// type: "doc",
// label: "architecture",
// id: "docs/overview/architecture",
// },
// ],
// },
// ],
companySidebar: [ companySidebar: [
// { // {
// type: "category", // type: "category",