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

Hide incomplete pages

Browse Source
This commit is contained in:
Daniel 2023-11-19 23:12:17 +08:00
parent 18059c22da
commit 3d466dc6cb
6 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/specs/architecture.md
View File

@ -2,6 +2,12 @@
title: Architecture title: Architecture
--- ---
:::warning
This page is still under construction, and should be read as a scratchpad
:::
- Jan is built using modules - Jan is built using modules
- Plugin architecture (on Pluggable-Electron) - Plugin architecture (on Pluggable-Electron)

2
docs/docs/specs/chats.md
View File

@ -4,7 +4,7 @@ title: Chats
:::warning :::warning
Draft Specification: functionality has not been implemented yet. This page is still under construction, and should be read as a scratchpad
::: :::

8
docs/docs/specs/data-structures.md
View File

@ -2,6 +2,12 @@
title: Data Structures title: Data Structures
--- ---
:::warning
This page is still under construction, and should be read as a scratchpad
:::
```sh ```sh
janroot/ janroot/
@ -18,8 +24,6 @@ janroot/
model.json model.json
``` ```
Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability. Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability.
```sh= ```sh=

3
docs/docs/specs/models.md
View File

@ -222,8 +222,9 @@ Currently, pasting a TheBloke Huggingface link in the Explore Models page will f
- We should use the OpenAPI spec to discuss APIs - We should use the OpenAPI spec to discuss APIs
- Dan's view: This needs @louis and App Pod to review as they are more familiar with this - Dan's view: This needs @louis and App Pod to review as they are more familiar with this
- Dan's view: Start/Stop model should have some UI indicator (show state, block input)
::: :::
See http://localhost:3001/api-reference#tag/Models. See http://localhost:3001/api-reference#tag/Models.

6
docs/docs/specs/user-interface.md
View File

@ -2,6 +2,12 @@
title: User Interface title: User Interface
--- ---
:::warning
This page is still under construction, and should be read as a scratchpad
:::
Jan provides a UI Kit for customize the UI for your use case. This means you can personalize the entire application according to your own brand and visual styles. Jan provides a UI Kit for customize the UI for your use case. This means you can personalize the entire application according to your own brand and visual styles.
This page gives you an overview of how to customize the UI. This page gives you an overview of how to customize the UI.

16
docs/sidebars.js
View File

@ -61,14 +61,14 @@ const sidebars = {
items: [ items: [
"specs/chats", "specs/chats",
"specs/models", "specs/models",
"specs/threads", // "specs/threads",
"specs/messages", // "specs/messages",
"specs/assistants", // "specs/assistants",
"specs/files", // "specs/files",
"specs/jan", // "specs/jan",
"specs/fine-tuning", // "specs/fine-tuning",
"specs/settings", // "specs/settings",
"specs/prompts", // "specs/prompts",
], ],
}, },
], ],