refactor: improve docs structure
@ -1,13 +1,16 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Architecture
|
||||
sidebar_position: 2
|
||||
title: Anatomy of an app
|
||||
---
|
||||
|
||||
## Jan overall architecture
|
||||
## Jan Architecture
|
||||
|
||||

|
||||
|
||||
- Jan platform includes the following components:
|
||||
|
||||
- Processes:
|
||||
- UI process:
|
||||
- UI process:
|
||||
- This is Electron framework `renderer` component (Web technology equivalent)
|
||||
- Jan provides core platform UI that:
|
||||
- Allows App to `register()` function blueprint with name and arguments
|
||||
@ -20,3 +23,18 @@ title: Architecture
|
||||
- `@janhq/core` library that exposes Core API for App to reuse. Currently it only supports App `index.ts`
|
||||
|
||||
- Vertically, there are `Platform Core` component and `App` component. Each of those includes UI and Node process that work in pair.
|
||||
|
||||
##
|
||||
|
||||
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
|
||||

|
||||
6
docs/docs/getting-started/build-an-app.md
Normal file
@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Build an app
|
||||
---
|
||||
|
||||
TODO: quickstart tutorial
|
||||
6
docs/docs/getting-started/development-workflow.md
Normal file
@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Development workflow
|
||||
---
|
||||
|
||||
todo
|
||||
|
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 +1,4 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Concepts
|
||||
---
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
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,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: How to Build a Jan App
|
||||
title: Building a chat app
|
||||
---
|
||||
|
||||
TODO
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: How to Build RAG App
|
||||
title: Building a RAG app
|
||||
---
|
||||
|
||||
TODO
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: How to Publish a Jan App
|
||||
title: Publishing a Jan app
|
||||
---
|
||||
|
||||
TODO
|
||||
|
||||
@ -117,7 +117,7 @@ const config = {
|
||||
src: "img/logo.svg",
|
||||
},
|
||||
items: [
|
||||
// Navbar Top
|
||||
// Navbar left
|
||||
// {
|
||||
// type: "docSidebar",
|
||||
// sidebarId: "featuresSidebar",
|
||||
@ -135,7 +135,7 @@ const config = {
|
||||
type: "docSidebar",
|
||||
sidebarId: "guidesSidebar",
|
||||
position: "right",
|
||||
label: "Guides",
|
||||
label: "User Guides",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
|
||||
@ -49,13 +49,13 @@ const sidebars = {
|
||||
devSidebar: [
|
||||
{
|
||||
type: "category",
|
||||
label: "Overview",
|
||||
label: "Getting Started",
|
||||
collapsible: true,
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
type: "autogenerated",
|
||||
dirName: "overview",
|
||||
dirName: "getting-started",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||