diff --git a/docs/docs/specs/architecture.md b/docs/docs/specs/architecture.md index 962b928aa..15a1b196d 100644 --- a/docs/docs/specs/architecture.md +++ b/docs/docs/specs/architecture.md @@ -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) diff --git a/docs/docs/specs/chats.md b/docs/docs/specs/chats.md index c52e87a90..c6e9c1681 100644 --- a/docs/docs/specs/chats.md +++ b/docs/docs/specs/chats.md @@ -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 ::: diff --git a/docs/docs/specs/data-structures.md b/docs/docs/specs/data-structures.md index d3f8507f4..3852a3823 100644 --- a/docs/docs/specs/data-structures.md +++ b/docs/docs/specs/data-structures.md @@ -2,6 +2,12 @@ title: Data Structures --- +:::warning + +This page is still under construction, and should be read as a scratchpad + +::: + ```sh janroot/ @@ -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= diff --git a/docs/docs/specs/models.md b/docs/docs/specs/models.md index 19f610cf3..c214f7557 100644 --- a/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -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. diff --git a/docs/docs/specs/user-interface.md b/docs/docs/specs/user-interface.md index 8085b5b0e..c540a6973 100644 --- a/docs/docs/specs/user-interface.md +++ b/docs/docs/specs/user-interface.md @@ -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. diff --git a/docs/sidebars.js b/docs/sidebars.js index fe04d330a..aa05c4117 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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", ], }, ],