refactor: docs url structure
0xSage
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: About Jan
|
||||
slug: /about
|
||||
---
|
||||
|
||||
## Problem
|
||||
|
||||
## Ideal Customer Persona
|
||||
|
||||
## Business Model
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Brand Assets
|
||||
---
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: Team
|
||||
---
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Changelog
|
||||
---
|
||||
|
||||
TODO
|
||||
@ -1,6 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Getting Started
|
||||
---
|
||||
|
||||
TODO
|
||||
|
Before Width: | Height: | Size: 388 KiB After Width: | Height: | Size: 388 KiB |
|
Before Width: | Height: | Size: 945 KiB After Width: | Height: | Size: 945 KiB |
|
Before Width: | Height: | Size: 2.2 MiB After Width: | Height: | Size: 2.2 MiB |
|
Before Width: | Height: | Size: 453 KiB After Width: | Height: | Size: 453 KiB |
|
Before Width: | Height: | Size: 349 KiB After Width: | Height: | Size: 349 KiB |
|
Before Width: | Height: | Size: 553 KiB After Width: | Height: | Size: 553 KiB |
|
Before Width: | Height: | Size: 636 KiB After Width: | Height: | Size: 636 KiB |
@ -1,16 +1,17 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 3
|
||||
title: App Anatomy
|
||||
---
|
||||
|
||||
Platform has 3 events that are broadcast to installed Apps
|
||||
|
||||
|
||||
- onLaunch()
|
||||
|
||||
|
||||
- onStart()
|
||||
|
||||
|
||||
- onDispose()
|
||||
|
||||
|
||||
- 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
|
||||
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 2
|
||||
title: 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 App: Next gen App built on Jan Plaform as `portable intelligence` that can be run everywhere.
|
||||
- Models:
|
||||
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
@ -1,5 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Overview
|
||||
slug: /platform
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Jan Desktop
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Jan Mobile
|
||||
---
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: Products
|
||||
slug: /product
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Jan Server
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Education
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Finance
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Healthcare
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Law
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Public Sector
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Software Engineering
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Personal AI
|
||||
---
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Self-Hosted ChatGPT
|
||||
---
|
||||
@ -1,4 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
slug: /solutions
|
||||
---
|
||||
@ -124,12 +124,6 @@ const config = {
|
||||
// position: "left",
|
||||
// label: "Platform",
|
||||
// },
|
||||
// {
|
||||
// type: "docSidebar",
|
||||
// sidebarId: "solutionsSidebar",
|
||||
// position: "left",
|
||||
// label: "Solutions",
|
||||
// },
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "companySidebar",
|
||||
@ -137,28 +131,18 @@ const config = {
|
||||
label: "Company",
|
||||
},
|
||||
// Navbar right
|
||||
// {
|
||||
// type: "docSidebar",
|
||||
// sidebarId: "guidesSidebar",
|
||||
// position: "right",
|
||||
// label: "Guides",
|
||||
// },
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "docsSidebar",
|
||||
sidebarId: "guidesSidebar",
|
||||
position: "right",
|
||||
label: "Guides",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "devSidebar",
|
||||
position: "right",
|
||||
label: "Developer",
|
||||
},
|
||||
// {
|
||||
// position: "right",
|
||||
// label: "API",
|
||||
// to: "/api",
|
||||
// },
|
||||
// {
|
||||
// href: "https://github.com/janhq/jan",
|
||||
// label: "GitHub",
|
||||
// position: "right",
|
||||
// },
|
||||
],
|
||||
},
|
||||
prism: {
|
||||
|
||||
109
docs/sidebars.js
@ -4,7 +4,7 @@
|
||||
- render a sidebar for each doc of that group
|
||||
- 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.
|
||||
*/
|
||||
@ -13,19 +13,7 @@
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
|
||||
// But you can create a sidebar manually
|
||||
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",
|
||||
label: "Features",
|
||||
@ -41,33 +29,24 @@ const sidebars = {
|
||||
},
|
||||
],
|
||||
|
||||
// Note: Tab name is "Use Cases"
|
||||
solutionsSidebar: [
|
||||
// "solutions/solutions",
|
||||
// Autogenerate docs from /guides
|
||||
guidesSidebar: [
|
||||
{
|
||||
type: "category",
|
||||
label: "Solutions",
|
||||
label: "Guides",
|
||||
collapsible: true,
|
||||
collapsed: false,
|
||||
items: ["solutions/self-hosted", "solutions/personal-ai"],
|
||||
collapsed: true,
|
||||
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",
|
||||
label: "Overview",
|
||||
@ -75,19 +54,8 @@ const sidebars = {
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
type: "doc",
|
||||
label: "Architecture",
|
||||
id: "docs/overview/architecture",
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "Concepts",
|
||||
id: "docs/overview/concepts",
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "App Anatomy",
|
||||
id: "docs/overview/app_anatomy",
|
||||
type: "autogenerated",
|
||||
dirName: "overview",
|
||||
},
|
||||
],
|
||||
},
|
||||
@ -98,19 +66,8 @@ const sidebars = {
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
type: "doc",
|
||||
label: "@janhq/core",
|
||||
id: "docs/reference/coreservice",
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "@janhq/models",
|
||||
id: "docs/reference/models_catalog",
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "@janhq/plugins",
|
||||
id: "docs/reference/plugins_catalog",
|
||||
type: "autogenerated",
|
||||
dirName: "reference",
|
||||
},
|
||||
],
|
||||
},
|
||||
@ -121,19 +78,8 @@ const sidebars = {
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
type: "doc",
|
||||
label: "How to Build a Chat App",
|
||||
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",
|
||||
type: "autogenerated",
|
||||
dirName: "tutorials",
|
||||
},
|
||||
],
|
||||
},
|
||||
@ -146,27 +92,12 @@ const sidebars = {
|
||||
{
|
||||
type: "doc",
|
||||
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: [
|
||||
// {
|
||||
// type: "category",
|
||||
|
||||