Skip to content

Commit

Permalink
Hide incomplete pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dan-homebrew committed Nov 19, 2023
1 parent 18059c2 commit 3d466dc
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 12 deletions.
6 changes: 6 additions & 0 deletions docs/docs/specs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Architecture
---

:::warning

This page is still under construction, and should be read as a scratchpad

:::

- Jan is built using modules
- Plugin architecture (on Pluggable-Electron)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/specs/chats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Chats

:::warning

Draft Specification: functionality has not been implemented yet.
This page is still under construction, and should be read as a scratchpad

:::

Expand Down
8 changes: 6 additions & 2 deletions docs/docs/specs/data-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Data Structures
---

:::warning

This page is still under construction, and should be read as a scratchpad

:::


```sh
janroot/
Expand All @@ -18,8 +24,6 @@ janroot/
model.json
```



Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability.

```sh=
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/specs/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
- 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.

Expand Down
6 changes: 6 additions & 0 deletions docs/docs/specs/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
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.

This page gives you an overview of how to customize the UI.
Expand Down
16 changes: 8 additions & 8 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ const sidebars = {
items: [
"specs/chats",
"specs/models",
"specs/threads",
"specs/messages",
"specs/assistants",
"specs/files",
"specs/jan",
"specs/fine-tuning",
"specs/settings",
"specs/prompts",
// "specs/threads",
// "specs/messages",
// "specs/assistants",
// "specs/files",
// "specs/jan",
// "specs/fine-tuning",
// "specs/settings",
// "specs/prompts",
],
},
],
Expand Down

0 comments on commit 3d466dc

Please sign in to comment.