Refactor structure for Developers
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 2
|
|
||||||
title: Anatomy of 👋Jan
|
title: Anatomy of 👋Jan
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -7,7 +6,7 @@ This page explains all the architecture of [Jan](https://Jan/).
|
|||||||
|
|
||||||
## Synchronous architecture
|
## Synchronous architecture
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
@ -60,7 +59,7 @@ With **Plugins and Apps**, users can build a broader ecosystem surrounding Jan.
|
|||||||
|
|
||||||
## Asynchronous architecture
|
## Asynchronous architecture
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
@ -97,7 +96,7 @@ These are modular components or extensions designed to enhance the application's
|
|||||||
|
|
||||||
## Jan workflow
|
## Jan workflow
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
@ -163,7 +162,7 @@ This represents applications or extensions that can be integrated with Jan.
|
|||||||
|
|
||||||
## Jan Platform
|
## Jan Platform
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 2
|
|
||||||
title: Build an app
|
title: Build an app
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -145,7 +144,7 @@ module.exports = {
|
|||||||
|
|
||||||
## App installation
|
## App installation
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- `Select` the built `*.tar.gz` file
|
- `Select` the built `*.tar.gz` file
|
||||||
- Jan will reload after new apps get installed
|
- Jan will reload after new apps get installed
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 3
|
|
||||||
title: Publishing an app
|
title: Publishing an app
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 1
|
|
||||||
title: Overview
|
title: Overview
|
||||||
---
|
---
|
||||||
Jan's mission is to power the next-gen App with limitless extensibility by providing users with the following:
|
Jan's mission is to power the next-gen App with limitless extensibility by providing users with the following:
|
||||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 778 KiB After Width: | Height: | Size: 778 KiB |
|
Before Width: | Height: | Size: 232 KiB After Width: | Height: | Size: 232 KiB |
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 158 KiB |
@ -36,7 +36,7 @@ Open your browser at [http://localhost:4000](http://localhost:4000)
|
|||||||
|
|
||||||
### Architecture
|
### Architecture
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### TODOs
|
### TODOs
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 4
|
title: Nitro
|
||||||
title: Nitro (C++ Inference Engine)
|
slug: /nitro
|
||||||
---
|
---
|
||||||
|
|
||||||
Nitro, is the inference engine that powers Jan. Nitro is written in C++, optimized for edge deployment.
|
Nitro, is the inference engine that powers Jan. Nitro is written in C++, optimized for edge deployment.
|
||||||
@ -73,4 +73,4 @@ curl -X POST 'http://localhost:3928/inferences/llamacpp/loadmodel' \
|
|||||||
|
|
||||||
## Architecture diagram
|
## Architecture diagram
|
||||||
|
|
||||||

|

|
||||||
@ -48,39 +48,41 @@ const sidebars = {
|
|||||||
],
|
],
|
||||||
|
|
||||||
devSidebar: [
|
devSidebar: [
|
||||||
|
"developers/developers",
|
||||||
|
"nitro/nitro",
|
||||||
{
|
{
|
||||||
type: "category",
|
type: "category",
|
||||||
label: "Getting Started",
|
label: "Apps",
|
||||||
collapsible: true,
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
type: "autogenerated",
|
|
||||||
dirName: "getting-started",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: "category",
|
|
||||||
label: "Reference",
|
|
||||||
collapsible: true,
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
type: "autogenerated",
|
|
||||||
dirName: "reference",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: "category",
|
|
||||||
label: "Apps (Plugins)",
|
|
||||||
collapsible: true,
|
collapsible: true,
|
||||||
collapsed: true,
|
collapsed: true,
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
type: "autogenerated",
|
type: "autogenerated",
|
||||||
dirName: "apps",
|
dirName: "developers/apps",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "Plugins",
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
type: "autogenerated",
|
||||||
|
dirName: "developers/plugins",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "API Reference",
|
||||||
|
collapsible: true,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
type: "autogenerated",
|
||||||
|
dirName: "reference",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||