From a2c6395f2c0fdc16e9b136f5cec3005e58267a63 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Wed, 20 Dec 2023 13:38:54 +0800 Subject: [PATCH] docs: refactor routes --- docs/README.md | 30 ++++- .../01-overview/01-architecture.md} | 19 +++- .../01-overview/02-file-based.md} | 13 ++- .../01-overview/03-user-interface.md} | 13 ++- .../01-overview/README.md} | 14 ++- .../01-your-first-assistant.md | 9 ++ .../02-assistant-anatomy.md | 9 ++ .../03-package-your-assistant.md | 9 ++ .../developer/02-build-assistant/README.md | 12 ++ .../03-build-engine/01-your-first-engine.md | 9 ++ .../03-build-engine/02-engine-anatomy.md} | 6 +- .../03-build-engine/03-package-your-engine.md | 9 ++ docs/docs/developer/03-build-engine/README.md | 12 ++ .../01-your-first-extension.md | 9 ++ .../02-extension-anatomy.md | 2 +- .../03-package-your-assistant.md | 9 ++ .../04-build-extension/README.md} | 2 + .../02-get-started/03-use-local-server.md | 7 -- .../02-get-started/04-build-on-desktop.md | 7 -- .../docs/02-get-started/05-build-on-mobile.md | 7 -- docs/docs/docs/02-get-started/README.md | 12 -- .../docs/03-extension-capabilities/01-Core.md | 7 -- .../02-application.mdx | 7 -- .../docs/04-application-extensions/README.md | 7 -- .../04-application-extensions/assistant.md | 7 -- .../04-application-extensions/inference.md | 7 -- .../docs/04-application-extensions/model.md | 7 -- .../04-application-extensions/monitoring.md | 7 -- .../threads-messages.md | 7 -- docs/docs/docs/05-ui-kit/README.md | 7 -- docs/docs/docs/README.md | 6 + docs/docs/docs/engineering/README.md | 5 + .../{specs => docs}/engineering/assistants.md | 13 ++- .../docs/{specs => docs}/engineering/chats.md | 13 ++- .../{specs => docs}/engineering/engine.md | 9 +- .../docs/{specs => docs}/engineering/files.md | 13 ++- docs/docs/docs/engineering/fine-tuning.md | 17 +++ .../{specs => docs}/engineering/messages.md | 13 ++- .../{specs => docs}/engineering/models.md | 18 ++- .../{specs => docs}/engineering/prompts.md | 13 ++- .../{specs => docs}/engineering/threads.md | 13 ++- docs/docs/{specs => docs}/img/chat-screen.png | Bin docs/docs/{specs => docs}/img/hub-screen.png | Bin .../{specs => docs}/img/settings-screen.png | Bin .../{specs => docs}/img/system-screen.png | Bin docs/docs/docs/product/README.md | 3 + docs/docs/{specs => docs}/product/chat.md | 13 ++- docs/docs/{specs => docs}/product/hub.md | 13 ++- docs/docs/{specs => docs/product}/jan.md | 16 ++- docs/docs/{specs => docs}/product/settings.md | 13 ++- .../{specs => docs}/product/system-monitor.md | 13 ++- .../{introduction.md => 00-overview.md} | 2 +- .../02-installation/01-mac.md} | 33 +++++- .../02-installation/02-windows.md} | 30 +++-- .../02-installation/03-linux.md} | 26 ++++- .../02-installation/04-from-source.md} | 27 ++++- .../02-installation/README.mdx} | 105 +++++++++++++++++- .../guides/03-chatting/01-start-thread.md | 3 + .../docs/guides/03-chatting/02-upload-docs.md | 3 + .../guides/03-chatting/03-upload-images.md | 3 + .../guides/03-chatting/04-manage-history.md | 3 + docs/docs/guides/03-chatting/README.md | 3 + .../04-using-models/01-install-from-hub.mdx | 15 +++ .../02-import-manually.mdx} | 14 +-- .../04-using-models/03-customize-models.md | 3 + .../04-using-models/04-package-models.md | 3 + docs/docs/guides/04-using-models/README.md | 3 + .../01-server.md} | 22 +++- docs/docs/guides/05-using-server/README.md | 3 + .../01-import-extensions.md | 3 + .../02-extension-settings.md | 5 + .../docs/guides/06-using-extensions/README.md | 3 + docs/docs/guides/quickstart.mdx | 81 -------------- docs/docs/specs/engineering/fine-tuning.md | 8 -- docs/docusaurus.config.js | 4 +- docs/sidebars.js | 71 +----------- 76 files changed, 609 insertions(+), 353 deletions(-) rename docs/docs/{specs/architecture.md => developer/01-overview/01-architecture.md} (76%) rename docs/docs/{specs/file-based.md => developer/01-overview/02-file-based.md} (91%) rename docs/docs/{specs/user-interface.md => developer/01-overview/03-user-interface.md} (89%) rename docs/docs/{docs/01-overview.md => developer/01-overview/README.md} (75%) create mode 100644 docs/docs/developer/02-build-assistant/01-your-first-assistant.md create mode 100644 docs/docs/developer/02-build-assistant/02-assistant-anatomy.md create mode 100644 docs/docs/developer/02-build-assistant/03-package-your-assistant.md create mode 100644 docs/docs/developer/02-build-assistant/README.md create mode 100644 docs/docs/developer/03-build-engine/01-your-first-engine.md rename docs/docs/{docs/03-extension-capabilities/README.md => developer/03-build-engine/02-engine-anatomy.md} (52%) create mode 100644 docs/docs/developer/03-build-engine/03-package-your-engine.md create mode 100644 docs/docs/developer/03-build-engine/README.md create mode 100644 docs/docs/developer/04-build-extension/01-your-first-extension.md rename docs/docs/{docs/02-get-started => developer/04-build-extension}/02-extension-anatomy.md (77%) create mode 100644 docs/docs/developer/04-build-extension/03-package-your-assistant.md rename docs/docs/{docs/02-get-started/01-build-extension.md => developer/04-build-extension/README.md} (87%) delete mode 100644 docs/docs/docs/02-get-started/03-use-local-server.md delete mode 100644 docs/docs/docs/02-get-started/04-build-on-desktop.md delete mode 100644 docs/docs/docs/02-get-started/05-build-on-mobile.md delete mode 100644 docs/docs/docs/02-get-started/README.md delete mode 100644 docs/docs/docs/03-extension-capabilities/01-Core.md delete mode 100644 docs/docs/docs/03-extension-capabilities/02-application.mdx delete mode 100644 docs/docs/docs/04-application-extensions/README.md delete mode 100644 docs/docs/docs/04-application-extensions/assistant.md delete mode 100644 docs/docs/docs/04-application-extensions/inference.md delete mode 100644 docs/docs/docs/04-application-extensions/model.md delete mode 100644 docs/docs/docs/04-application-extensions/monitoring.md delete mode 100644 docs/docs/docs/04-application-extensions/threads-messages.md delete mode 100644 docs/docs/docs/05-ui-kit/README.md create mode 100644 docs/docs/docs/README.md create mode 100644 docs/docs/docs/engineering/README.md rename docs/docs/{specs => docs}/engineering/assistants.md (95%) rename docs/docs/{specs => docs}/engineering/chats.md (87%) rename docs/docs/{specs => docs}/engineering/engine.md (94%) rename docs/docs/{specs => docs}/engineering/files.md (91%) create mode 100644 docs/docs/docs/engineering/fine-tuning.md rename docs/docs/{specs => docs}/engineering/messages.md (94%) rename docs/docs/{specs => docs}/engineering/models.md (95%) rename docs/docs/{specs => docs}/engineering/prompts.md (56%) rename docs/docs/{specs => docs}/engineering/threads.md (93%) rename docs/docs/{specs => docs}/img/chat-screen.png (100%) rename docs/docs/{specs => docs}/img/hub-screen.png (100%) rename docs/docs/{specs => docs}/img/settings-screen.png (100%) rename docs/docs/{specs => docs}/img/system-screen.png (100%) create mode 100644 docs/docs/docs/product/README.md rename docs/docs/{specs => docs}/product/chat.md (74%) rename docs/docs/{specs => docs}/product/hub.md (77%) rename docs/docs/{specs => docs/product}/jan.md (79%) rename docs/docs/{specs => docs}/product/settings.md (81%) rename docs/docs/{specs => docs}/product/system-monitor.md (70%) rename docs/docs/guides/{introduction.md => 00-overview.md} (99%) rename docs/docs/{install/mac.md => guides/02-installation/01-mac.md} (86%) rename docs/docs/{install/windows.md => guides/02-installation/02-windows.md} (75%) rename docs/docs/{install/linux.md => guides/02-installation/03-linux.md} (78%) rename docs/docs/{install/from-source.md => guides/02-installation/04-from-source.md} (85%) rename docs/docs/{install/overview.md => guides/02-installation/README.mdx} (57%) create mode 100644 docs/docs/guides/03-chatting/01-start-thread.md create mode 100644 docs/docs/guides/03-chatting/02-upload-docs.md create mode 100644 docs/docs/guides/03-chatting/03-upload-images.md create mode 100644 docs/docs/guides/03-chatting/04-manage-history.md create mode 100644 docs/docs/guides/03-chatting/README.md create mode 100644 docs/docs/guides/04-using-models/01-install-from-hub.mdx rename docs/docs/guides/{models.mdx => 04-using-models/02-import-manually.mdx} (92%) create mode 100644 docs/docs/guides/04-using-models/03-customize-models.md create mode 100644 docs/docs/guides/04-using-models/04-package-models.md create mode 100644 docs/docs/guides/04-using-models/README.md rename docs/docs/guides/{server.md => 05-using-server/01-server.md} (59%) create mode 100644 docs/docs/guides/05-using-server/README.md create mode 100644 docs/docs/guides/06-using-extensions/01-import-extensions.md create mode 100644 docs/docs/guides/06-using-extensions/02-extension-settings.md create mode 100644 docs/docs/guides/06-using-extensions/README.md delete mode 100644 docs/docs/guides/quickstart.mdx delete mode 100644 docs/docs/specs/engineering/fine-tuning.md diff --git a/docs/README.md b/docs/README.md index 63d21064b..b5d31702f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,33 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +## Information Architecture + +We try to **keep routes consistent** to maintain SEO. + +- `/guides`: Guides on how to use the Jan application, with GIFs. For end users who are directly using Jan. Always assume users are not technical. + +- `/developer`: Developer docs on how to extend Jan. These pages are about what people can build with our software. We must hide the complexity of HOW the app is built, but explain just enough of the high level architecture so devs know enough to build on top of it. + +- `/api-reference`: Reference documentation, written in Swagger/OpenAPI format. + +- `/docs`: Engineering specs and product specs, i.e. HOW the app is built. Mostly for internal reference and for our core contributors who are building the SDK itself. + +### Sidebar Autogeneration + +The order of each page is either explicitly defined in `sidebar.js` or follows the [Docusaurus autogenerated](https://docusaurus.io/docs/next/sidebar/autogenerated) naming format, `##-path-name.md`. + +Important slugs are hardcoded at the document level (and shouldn't be rerouted): + +```md +--- +title: Overview +slug: /docs +--- +``` + +## Contributing + ### Installation ``` @@ -48,5 +75,6 @@ When a PR is created, the preview URL will be automatically commented on the PR. The documentation will then be published to [https://jan.ai/](https://jan.ai/) when the PR is merged to `main`. ### Additional Plugins + - @docusaurus/theme-live-codeblock -- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json` \ No newline at end of file +- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json` diff --git a/docs/docs/specs/architecture.md b/docs/docs/developer/01-overview/01-architecture.md similarity index 76% rename from docs/docs/specs/architecture.md rename to docs/docs/developer/01-overview/01-architecture.md index dd96d5d8b..432b12537 100644 --- a/docs/docs/specs/architecture.md +++ b/docs/docs/developer/01-overview/01-architecture.md @@ -1,8 +1,18 @@ --- title: Architecture -slug: /specs +slug: /developer/architecture description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::warning @@ -14,8 +24,9 @@ This page is still under construction, and should be read as a scratchpad ## Overview - Jan has a modular architecture and is largely built on top of its own modules. -- Jan uses a local [file-based approach](/specs/file-based) for data persistence. -- Jan currently supports an Electron-based [Desktop UI](https://github.com/janhq/jan) and a C++ inference engine called [Nitro](https://nitro.jan.ai/docs/). +- Jan uses a local [file-based approach](/developer/file-based) for data persistence. +- Jan provides an Electron-based [Desktop UI](https://github.com/janhq/jan). +- Jan provides an embeddable inference engine, written in C++, called [Nitro](https://nitro.jan.ai/docs/). ## Extensions diff --git a/docs/docs/specs/file-based.md b/docs/docs/developer/01-overview/02-file-based.md similarity index 91% rename from docs/docs/specs/file-based.md rename to docs/docs/developer/01-overview/02-file-based.md index 6296199d9..653eba3f5 100644 --- a/docs/docs/specs/file-based.md +++ b/docs/docs/developer/01-overview/02-file-based.md @@ -1,7 +1,18 @@ --- title: File-based Approach +slug: /developer/file-based description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::warning diff --git a/docs/docs/specs/user-interface.md b/docs/docs/developer/01-overview/03-user-interface.md similarity index 89% rename from docs/docs/specs/user-interface.md rename to docs/docs/developer/01-overview/03-user-interface.md index bcf72f84c..eb6eac89e 100644 --- a/docs/docs/specs/user-interface.md +++ b/docs/docs/developer/01-overview/03-user-interface.md @@ -1,7 +1,18 @@ --- title: User Interface +slug: /developer/ui description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::warning diff --git a/docs/docs/docs/01-overview.md b/docs/docs/developer/01-overview/README.md similarity index 75% rename from docs/docs/docs/01-overview.md rename to docs/docs/developer/01-overview/README.md index 8b1860198..0a7467cae 100644 --- a/docs/docs/docs/01-overview.md +++ b/docs/docs/developer/01-overview/README.md @@ -1,6 +1,6 @@ --- title: Overview -slug: /docs +slug: /developer description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ @@ -15,6 +15,8 @@ keywords: ] --- +TODO: pair this down. just quicklinks. + Jan SDK is an **extensible framework** that lets you build and run AI applications everywhere, with an emphasis on local first. It is available across Mac, Windows, Linux Desktops. It is also available as a headless server that can be deployed into any on-prem or cloud environments. @@ -35,17 +37,17 @@ The [Jan Desktop client](https://github.com/janhq/jan/releases) is built with Ja [Gif: show desktop & server side by side] -## Application Extensions +## Extensions -You can make feature level additions to Jan to extend the application UI & use cases. +You can extend the application UI & use cases through extensions. -Jan's growing developer community is constantly adding new integrations that improve your productivity. +Jan's core devs and growing developer community are constantly adding new extensions that bring feature level improvements and 3rd party integrations. Read more about [application extensions](/docs/extension-capabilities/application). -## Core Extensions +## Core SDK -You can make framework or driver level additions to Jan to extend how Jan natively runs on your infrastructure. For example, you can customize inline OS commands or even integrate Jan with your IoT. +You can extend how Jan natively runs on your infrastructure, including making framework or driver level changes, through modifying the `core SDK`. For example, you can create inline OS commands or even integrate Jan with your IoT. Core Extension improvements can be packaged back into the core SDK and distributed to other extension developers. diff --git a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md new file mode 100644 index 000000000..11999981f --- /dev/null +++ b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md @@ -0,0 +1,9 @@ +--- +title: Your First Assistant +--- + +:::caution +This is currently under development. +::: + +A quickstart on how to build an assistant diff --git a/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md b/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md new file mode 100644 index 000000000..6c5fc1035 --- /dev/null +++ b/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md @@ -0,0 +1,9 @@ +--- +title: Anatomy of an Assistant +--- + +:::caution +This is currently under development. +::: + +An overview of assistant.json diff --git a/docs/docs/developer/02-build-assistant/03-package-your-assistant.md b/docs/docs/developer/02-build-assistant/03-package-your-assistant.md new file mode 100644 index 000000000..8d384cb8a --- /dev/null +++ b/docs/docs/developer/02-build-assistant/03-package-your-assistant.md @@ -0,0 +1,9 @@ +--- +title: Package your Assistant +--- + +:::caution +This is currently under development. +::: + +Packaging, exporting, sharing, publishing an assistant to Hub diff --git a/docs/docs/developer/02-build-assistant/README.md b/docs/docs/developer/02-build-assistant/README.md new file mode 100644 index 000000000..28264ae9c --- /dev/null +++ b/docs/docs/developer/02-build-assistant/README.md @@ -0,0 +1,12 @@ +--- +title: Build an Assistant +--- + +:::caution +This is currently under development. +::: + +In this tutorial you will learn: + +- +- diff --git a/docs/docs/developer/03-build-engine/01-your-first-engine.md b/docs/docs/developer/03-build-engine/01-your-first-engine.md new file mode 100644 index 000000000..8323354f8 --- /dev/null +++ b/docs/docs/developer/03-build-engine/01-your-first-engine.md @@ -0,0 +1,9 @@ +--- +title: Your First Assistant +--- + +:::caution +This is currently under development. +::: + +A quickstart on how to integrate tensorrt llm diff --git a/docs/docs/docs/03-extension-capabilities/README.md b/docs/docs/developer/03-build-engine/02-engine-anatomy.md similarity index 52% rename from docs/docs/docs/03-extension-capabilities/README.md rename to docs/docs/developer/03-build-engine/02-engine-anatomy.md index 2a52325b1..45c657141 100644 --- a/docs/docs/docs/03-extension-capabilities/README.md +++ b/docs/docs/developer/03-build-engine/02-engine-anatomy.md @@ -1,9 +1,9 @@ --- -title: Extension Capabilities +title: Anatomy of an Engine --- -# Overview - :::caution This is currently under development. ::: + +An overview of engine.json diff --git a/docs/docs/developer/03-build-engine/03-package-your-engine.md b/docs/docs/developer/03-build-engine/03-package-your-engine.md new file mode 100644 index 000000000..d6acfd6fd --- /dev/null +++ b/docs/docs/developer/03-build-engine/03-package-your-engine.md @@ -0,0 +1,9 @@ +--- +title: Package your Extension +--- + +:::caution +This is currently under development. +::: + +Packaging, exporting, sharing, publishing an engine config to Hub diff --git a/docs/docs/developer/03-build-engine/README.md b/docs/docs/developer/03-build-engine/README.md new file mode 100644 index 000000000..fa9f486fe --- /dev/null +++ b/docs/docs/developer/03-build-engine/README.md @@ -0,0 +1,12 @@ +--- +title: Build an Inference Engine +--- + +:::caution +This is currently under development. +::: + +In this tutorial you will learn: + +- +- diff --git a/docs/docs/developer/04-build-extension/01-your-first-extension.md b/docs/docs/developer/04-build-extension/01-your-first-extension.md new file mode 100644 index 000000000..0e5241e3c --- /dev/null +++ b/docs/docs/developer/04-build-extension/01-your-first-extension.md @@ -0,0 +1,9 @@ +--- +title: Your First Extension +--- + +:::caution +This is currently under development. +::: + +A quickstart on tensorrt-llm impl diff --git a/docs/docs/docs/02-get-started/02-extension-anatomy.md b/docs/docs/developer/04-build-extension/02-extension-anatomy.md similarity index 77% rename from docs/docs/docs/02-get-started/02-extension-anatomy.md rename to docs/docs/developer/04-build-extension/02-extension-anatomy.md index c4a372004..55b3def4b 100644 --- a/docs/docs/docs/02-get-started/02-extension-anatomy.md +++ b/docs/docs/developer/04-build-extension/02-extension-anatomy.md @@ -6,4 +6,4 @@ title: Anatomy of an Extension This is currently under development. ::: -Anatomy and lifecycle +An overview of engine.json diff --git a/docs/docs/developer/04-build-extension/03-package-your-assistant.md b/docs/docs/developer/04-build-extension/03-package-your-assistant.md new file mode 100644 index 000000000..c32a24a67 --- /dev/null +++ b/docs/docs/developer/04-build-extension/03-package-your-assistant.md @@ -0,0 +1,9 @@ +--- +title: Package your Extension +--- + +:::caution +This is currently under development. +::: + +Packaging, exporting, sharing, publishing an extension to Hub diff --git a/docs/docs/docs/02-get-started/01-build-extension.md b/docs/docs/developer/04-build-extension/README.md similarity index 87% rename from docs/docs/docs/02-get-started/01-build-extension.md rename to docs/docs/developer/04-build-extension/README.md index e84f25604..fb759164a 100644 --- a/docs/docs/docs/02-get-started/01-build-extension.md +++ b/docs/docs/developer/04-build-extension/README.md @@ -2,6 +2,8 @@ title: Build an Extension --- +# Overview + :::caution This is currently under development. ::: diff --git a/docs/docs/docs/02-get-started/03-use-local-server.md b/docs/docs/docs/02-get-started/03-use-local-server.md deleted file mode 100644 index e6b3f4627..000000000 --- a/docs/docs/docs/02-get-started/03-use-local-server.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Using the Local Server ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/02-get-started/04-build-on-desktop.md b/docs/docs/docs/02-get-started/04-build-on-desktop.md deleted file mode 100644 index e652953a0..000000000 --- a/docs/docs/docs/02-get-started/04-build-on-desktop.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Building for Desktop ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/02-get-started/05-build-on-mobile.md b/docs/docs/docs/02-get-started/05-build-on-mobile.md deleted file mode 100644 index 9a12f44a4..000000000 --- a/docs/docs/docs/02-get-started/05-build-on-mobile.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Building for Mobile ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/02-get-started/README.md b/docs/docs/docs/02-get-started/README.md deleted file mode 100644 index 3c8409423..000000000 --- a/docs/docs/docs/02-get-started/README.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get Started ---- - -:::caution -This is currently under development. -::: -There are various ways to build on top of Jan. - -1. Use Jan as a local AI server -2. Build a cross-platform extension for Desktop application -3. ... diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md deleted file mode 100644 index c84b45d89..000000000 --- a/docs/docs/docs/03-extension-capabilities/01-Core.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Core Extensions ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/03-extension-capabilities/02-application.mdx b/docs/docs/docs/03-extension-capabilities/02-application.mdx deleted file mode 100644 index 452394f33..000000000 --- a/docs/docs/docs/03-extension-capabilities/02-application.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Application Extensions ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/README.md b/docs/docs/docs/04-application-extensions/README.md deleted file mode 100644 index 452394f33..000000000 --- a/docs/docs/docs/04-application-extensions/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Application Extensions ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/assistant.md b/docs/docs/docs/04-application-extensions/assistant.md deleted file mode 100644 index 21378ad8e..000000000 --- a/docs/docs/docs/04-application-extensions/assistant.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Assistant ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/inference.md b/docs/docs/docs/04-application-extensions/inference.md deleted file mode 100644 index d333f02f3..000000000 --- a/docs/docs/docs/04-application-extensions/inference.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Inference ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/model.md b/docs/docs/docs/04-application-extensions/model.md deleted file mode 100644 index 77f27c94d..000000000 --- a/docs/docs/docs/04-application-extensions/model.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Model ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/monitoring.md b/docs/docs/docs/04-application-extensions/monitoring.md deleted file mode 100644 index 1f6d6af46..000000000 --- a/docs/docs/docs/04-application-extensions/monitoring.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Monitoring ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/04-application-extensions/threads-messages.md b/docs/docs/docs/04-application-extensions/threads-messages.md deleted file mode 100644 index b56f8d98a..000000000 --- a/docs/docs/docs/04-application-extensions/threads-messages.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Thread & Messages ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/05-ui-kit/README.md b/docs/docs/docs/05-ui-kit/README.md deleted file mode 100644 index 14196dd0f..000000000 --- a/docs/docs/docs/05-ui-kit/README.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: UI Kit ---- - -:::caution -This is currently under development. -::: diff --git a/docs/docs/docs/README.md b/docs/docs/docs/README.md new file mode 100644 index 000000000..d6ff08d55 --- /dev/null +++ b/docs/docs/docs/README.md @@ -0,0 +1,6 @@ +--- +title: Overview +slug: /docs +--- + +Hello world diff --git a/docs/docs/docs/engineering/README.md b/docs/docs/docs/engineering/README.md new file mode 100644 index 000000000..3c87ba845 --- /dev/null +++ b/docs/docs/docs/engineering/README.md @@ -0,0 +1,5 @@ +--- +title: Engineering Specs +--- + +Talk about CoreSDK here diff --git a/docs/docs/specs/engineering/assistants.md b/docs/docs/docs/engineering/assistants.md similarity index 95% rename from docs/docs/specs/engineering/assistants.md rename to docs/docs/docs/engineering/assistants.md index 50646f9cb..fa9c593ab 100644 --- a/docs/docs/specs/engineering/assistants.md +++ b/docs/docs/docs/engineering/assistants.md @@ -1,8 +1,17 @@ --- title: "Assistants" -slug: /specs/assistants description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::caution diff --git a/docs/docs/specs/engineering/chats.md b/docs/docs/docs/engineering/chats.md similarity index 87% rename from docs/docs/specs/engineering/chats.md rename to docs/docs/docs/engineering/chats.md index 8ba467d2a..7f6626b3e 100644 --- a/docs/docs/specs/engineering/chats.md +++ b/docs/docs/docs/engineering/chats.md @@ -1,8 +1,17 @@ --- title: Chats -slug: /specs/chats description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::caution diff --git a/docs/docs/specs/engineering/engine.md b/docs/docs/docs/engineering/engine.md similarity index 94% rename from docs/docs/specs/engineering/engine.md rename to docs/docs/docs/engineering/engine.md index d25fdfc04..653576f1b 100644 --- a/docs/docs/specs/engineering/engine.md +++ b/docs/docs/docs/engineering/engine.md @@ -1,6 +1,5 @@ --- title: Engine -slug: /specs/engine --- :::caution @@ -25,10 +24,10 @@ In the Jan application, engines serve as primary entities with the following cap ```yaml jan/ - engines/ - nitro.json - openai.json - ..... +engines/ +nitro.json +openai.json +..... ``` ## Engine Default Parameter Files diff --git a/docs/docs/specs/engineering/files.md b/docs/docs/docs/engineering/files.md similarity index 91% rename from docs/docs/specs/engineering/files.md rename to docs/docs/docs/engineering/files.md index 452a4645d..59ca27ec9 100644 --- a/docs/docs/specs/engineering/files.md +++ b/docs/docs/docs/engineering/files.md @@ -1,8 +1,17 @@ --- title: "Files" -slug: /specs/files description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::warning diff --git a/docs/docs/docs/engineering/fine-tuning.md b/docs/docs/docs/engineering/fine-tuning.md new file mode 100644 index 000000000..53ca2b206 --- /dev/null +++ b/docs/docs/docs/engineering/fine-tuning.md @@ -0,0 +1,17 @@ +--- +title: "Fine-tuning" +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- + +Todo: @hiro diff --git a/docs/docs/specs/engineering/messages.md b/docs/docs/docs/engineering/messages.md similarity index 94% rename from docs/docs/specs/engineering/messages.md rename to docs/docs/docs/engineering/messages.md index 4818378d9..8f2497002 100644 --- a/docs/docs/specs/engineering/messages.md +++ b/docs/docs/docs/engineering/messages.md @@ -1,8 +1,17 @@ --- title: Messages -slug: /specs/messages description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::caution diff --git a/docs/docs/specs/engineering/models.md b/docs/docs/docs/engineering/models.md similarity index 95% rename from docs/docs/specs/engineering/models.md rename to docs/docs/docs/engineering/models.md index 4fc75122f..cb0b44f41 100644 --- a/docs/docs/specs/engineering/models.md +++ b/docs/docs/docs/engineering/models.md @@ -1,8 +1,17 @@ --- title: Models -slug: /specs/models description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::caution @@ -53,7 +62,6 @@ jan/ # Jan root folder Here's a standard example `model.json` for a GGUF model. - ```js { "id": "zephyr-7b", // Defaults to foldername @@ -66,8 +74,8 @@ Here's a standard example `model.json` for a GGUF model. "description": null, // Defaults to null "state": enum[null, "ready"] "format": "ggufv3", // Defaults to "ggufv3" -"engine": "nitro", // engine_id specified in jan/engine folder -"engine_parameters": { // Engine parameters inside model.json can override +"engine": "nitro", // engine_id specified in jan/engine folder +"engine_parameters": { // Engine parameters inside model.json can override "ctx_len": 2048, // the value inside the base engine.json "ngl": 100, "embedding": true, diff --git a/docs/docs/specs/engineering/prompts.md b/docs/docs/docs/engineering/prompts.md similarity index 56% rename from docs/docs/specs/engineering/prompts.md rename to docs/docs/docs/engineering/prompts.md index 66e58bf77..22fc578af 100644 --- a/docs/docs/specs/engineering/prompts.md +++ b/docs/docs/docs/engineering/prompts.md @@ -1,8 +1,17 @@ --- title: Prompts -slug: /specs/prompts description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- - [ ] /prompts folder diff --git a/docs/docs/specs/engineering/threads.md b/docs/docs/docs/engineering/threads.md similarity index 93% rename from docs/docs/specs/engineering/threads.md rename to docs/docs/docs/engineering/threads.md index b6181b2c2..4eb37aea8 100644 --- a/docs/docs/specs/engineering/threads.md +++ b/docs/docs/docs/engineering/threads.md @@ -1,8 +1,17 @@ --- title: Threads -slug: /specs/threads description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::caution diff --git a/docs/docs/specs/img/chat-screen.png b/docs/docs/docs/img/chat-screen.png similarity index 100% rename from docs/docs/specs/img/chat-screen.png rename to docs/docs/docs/img/chat-screen.png diff --git a/docs/docs/specs/img/hub-screen.png b/docs/docs/docs/img/hub-screen.png similarity index 100% rename from docs/docs/specs/img/hub-screen.png rename to docs/docs/docs/img/hub-screen.png diff --git a/docs/docs/specs/img/settings-screen.png b/docs/docs/docs/img/settings-screen.png similarity index 100% rename from docs/docs/specs/img/settings-screen.png rename to docs/docs/docs/img/settings-screen.png diff --git a/docs/docs/specs/img/system-screen.png b/docs/docs/docs/img/system-screen.png similarity index 100% rename from docs/docs/specs/img/system-screen.png rename to docs/docs/docs/img/system-screen.png diff --git a/docs/docs/docs/product/README.md b/docs/docs/docs/product/README.md new file mode 100644 index 000000000..5a00a0cf2 --- /dev/null +++ b/docs/docs/docs/product/README.md @@ -0,0 +1,3 @@ +--- +title: Product Specs +--- diff --git a/docs/docs/specs/product/chat.md b/docs/docs/docs/product/chat.md similarity index 74% rename from docs/docs/specs/product/chat.md rename to docs/docs/docs/product/chat.md index 1f167a07b..f328f56be 100644 --- a/docs/docs/specs/product/chat.md +++ b/docs/docs/docs/product/chat.md @@ -1,8 +1,17 @@ --- title: Chat -slug: /specs/chat description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- ## Overview diff --git a/docs/docs/specs/product/hub.md b/docs/docs/docs/product/hub.md similarity index 77% rename from docs/docs/specs/product/hub.md rename to docs/docs/docs/product/hub.md index 14feab542..7171f8378 100644 --- a/docs/docs/specs/product/hub.md +++ b/docs/docs/docs/product/hub.md @@ -1,8 +1,17 @@ --- title: Hub -slug: /specs/hub description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- ## Overview diff --git a/docs/docs/specs/jan.md b/docs/docs/docs/product/jan.md similarity index 79% rename from docs/docs/specs/jan.md rename to docs/docs/docs/product/jan.md index 8cd1db98e..9e8973360 100644 --- a/docs/docs/specs/jan.md +++ b/docs/docs/docs/product/jan.md @@ -1,11 +1,19 @@ --- -title: Jan (Assistant) +title: Jan (The Default Assistant) description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- -## Jan: a "global" assistant - Jan ships with a default assistant "Jan" that lets users chat with any open source model out-of-the-box. This assistant is defined in `/jan`. It is a generic assistant to illustrate power of Jan. In the future, it will support additional features e.g. multi-assistant conversations diff --git a/docs/docs/specs/product/settings.md b/docs/docs/docs/product/settings.md similarity index 81% rename from docs/docs/specs/product/settings.md rename to docs/docs/docs/product/settings.md index 6d5b5939b..514139a00 100644 --- a/docs/docs/specs/product/settings.md +++ b/docs/docs/docs/product/settings.md @@ -1,8 +1,17 @@ --- title: Settings -slug: /specs/settings description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- ## Overview diff --git a/docs/docs/specs/product/system-monitor.md b/docs/docs/docs/product/system-monitor.md similarity index 70% rename from docs/docs/specs/product/system-monitor.md rename to docs/docs/docs/product/system-monitor.md index 3333eb9bd..761d9a7bf 100644 --- a/docs/docs/specs/product/system-monitor.md +++ b/docs/docs/docs/product/system-monitor.md @@ -1,8 +1,17 @@ --- title: System Monitor -slug: /specs/system-monitor description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- ## Overview diff --git a/docs/docs/guides/introduction.md b/docs/docs/guides/00-overview.md similarity index 99% rename from docs/docs/guides/introduction.md rename to docs/docs/guides/00-overview.md index bc40a0765..e6cf5d99a 100644 --- a/docs/docs/guides/introduction.md +++ b/docs/docs/guides/00-overview.md @@ -1,5 +1,5 @@ --- -title: Introduction +title: Overview slug: /guides description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: diff --git a/docs/docs/install/mac.md b/docs/docs/guides/02-installation/01-mac.md similarity index 86% rename from docs/docs/install/mac.md rename to docs/docs/guides/02-installation/01-mac.md index d1c5f1fc9..90a2c4c18 100644 --- a/docs/docs/install/mac.md +++ b/docs/docs/guides/02-installation/01-mac.md @@ -1,7 +1,18 @@ --- title: Mac +slug: /install/mac description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- # Installing Jan on MacOS @@ -13,7 +24,7 @@ Jan is available for download via our homepage, [https://jan.ai/](https://jan.ai For MacOS, the download should be available as a `.dmg` file in the following format. ```bash -# Intel Mac +# Intel Mac jan-mac-x64-{version}.dmg # Apple Silicon Mac jan-mac-arm64-{version}.dmg @@ -22,7 +33,8 @@ jan-mac-arm64-{version}.dmg The typical installation process taks around a minute. ## GitHub Releases -Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). + +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). Within the Releases' assets, you will find the following files for MacOS: @@ -37,10 +49,13 @@ jan-mac-arm64-{version}.zip ``` ## Uninstall Jan + As Jan is development mode, you might get stuck on a broken build To reset your installation + 1. Delete Jan from your `/Applications` folder 2. Delete Application data + ```bash # Newer versions rm -rf /Users/$(whoami)/Library/Application\ Support/jan @@ -48,23 +63,31 @@ rm -rf /Users/$(whoami)/Library/Application\ Support/jan # Versions 0.2.0 and older rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron ``` + 3. Clear Application cache + ```bash rm -rf /Users/$(whoami)/Library/Caches/jan* ``` + 4. Use the following commands to remove any dangling backend processes: + ```bash ps aux | grep nitro ``` + Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: + ```bash kill -9 ``` ## Common Questions -### Does Jan run on Apple Silicon machines? +### Does Jan run on Apple Silicon machines? + Yes, Jan supports MacOS Arm64 builds that can run on Macs with the Apple Silicon chipsets. You can install Jan on your Apple Silicon Mac by downloading the `jan-mac-arm64-.dmg` file from the [Jan's homepage](https://jan.ai/). ### Which package should I download for my Mac? -Jan supports both Intel and Apple Silicon Macs. To find which appropriate package to download for your Mac, please follow this official guide from Apple: [Get system information about your Mac - Apple Support](https://support.apple.com/guide/mac-help/syspr35536/mac). \ No newline at end of file + +Jan supports both Intel and Apple Silicon Macs. To find which appropriate package to download for your Mac, please follow this official guide from Apple: [Get system information about your Mac - Apple Support](https://support.apple.com/guide/mac-help/syspr35536/mac). diff --git a/docs/docs/install/windows.md b/docs/docs/guides/02-installation/02-windows.md similarity index 75% rename from docs/docs/install/windows.md rename to docs/docs/guides/02-installation/02-windows.md index 53db66ae7..cfaee1f5b 100644 --- a/docs/docs/install/windows.md +++ b/docs/docs/guides/02-installation/02-windows.md @@ -1,7 +1,18 @@ --- title: Windows +slug: /install/windows description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- # Installing Jan on Windows @@ -10,17 +21,17 @@ keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversation Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/). -For Windows, the download should be available as a `.exe` file in the following format. +For Windows, the download should be available as a `.exe` file in the following format. ```bash jan-win-x64-{version}.exe ``` -The typical installation process takes around a minute. +The typical installation process takes around a minute. ### GitHub Releases -Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). Within the Releases' assets, you will find the following files for Windows: @@ -31,7 +42,7 @@ jan-win-x64-{version}.exe ### Default Installation Directory -By default, Jan is installed in the following directory: +By default, Jan is installed in the following directory: ```bash # Default installation directory @@ -40,14 +51,14 @@ C:\Users\{username}\AppData\Local\Programs\Jan ## Uninstalling Jan -To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). +To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98). -To remove all user data associated with Jan, you can delete the `/Jan` directory in Windows' [AppData directory](https://superuser.com/questions/632891/what-is-appdata). +To remove all user data associated with Jan, you can delete the `/Jan` directory in Windows' [AppData directory](https://superuser.com/questions/632891/what-is-appdata). ```shell # Jan's User Data directory %AppData%\Jan -``` +``` ## Troubleshooting @@ -55,7 +66,6 @@ To remove all user data associated with Jan, you can delete the `/Jan` directory **Error: "Microsoft Defender Smartscreen prevented an unrecognized app from starting"** -Windows Defender may display the above warning when running the Jan Installer, as a standard security measure. +Windows Defender may display the above warning when running the Jan Installer, as a standard security measure. To proceed, select the "More info" option and select the "Run Anyway" option to continue with the installation. - diff --git a/docs/docs/install/linux.md b/docs/docs/guides/02-installation/03-linux.md similarity index 78% rename from docs/docs/install/linux.md rename to docs/docs/guides/02-installation/03-linux.md index 1ca22c97b..48ca12563 100644 --- a/docs/docs/install/linux.md +++ b/docs/docs/guides/02-installation/03-linux.md @@ -1,7 +1,18 @@ --- title: Linux +slug: /install/linux description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- # Installing Jan on Linux @@ -10,17 +21,17 @@ keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversation Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/). -For Linux, the download should be available as a `.deb` file in the following format. +For Linux, the download should be available as a `.deb` file in the following format. ```bash jan-linux-amd64-{version}.deb ``` -The typical installation process takes around a minute. +The typical installation process takes around a minute. ### GitHub Releases -Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). +Jan is also available from [Jan's GitHub Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest). Within the Releases' assets, you will find the following files for Linux: @@ -30,9 +41,12 @@ jan-linux-amd64-{version}.deb ``` ## Uninstall Jan + To uninstall VS Code on Linux, you should use your package manager's uninstall or remove option. For Debian/Ubuntu-based distributions, if you installed Jan via the `.deb` package, you can uninstall Jan using the following command: + ```bash sudo apt-get remove jan` # where jan is the name of Jan package -``` -In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at `$HOME/.config/Jan` and ~/.jan. This will return your system to its state prior to the installation of Jan. This method can also be used to reset all settings if you are experiencing any issues with Jan. \ No newline at end of file +``` + +In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at `$HOME/.config/Jan` and ~/.jan. This will return your system to its state prior to the installation of Jan. This method can also be used to reset all settings if you are experiencing any issues with Jan. diff --git a/docs/docs/install/from-source.md b/docs/docs/guides/02-installation/04-from-source.md similarity index 85% rename from docs/docs/install/from-source.md rename to docs/docs/guides/02-installation/04-from-source.md index f99228d80..cbd44242f 100644 --- a/docs/docs/install/from-source.md +++ b/docs/docs/guides/02-installation/04-from-source.md @@ -1,7 +1,18 @@ --- title: From Source +slug: /install/from-source description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- # Install Jan from Source @@ -9,20 +20,26 @@ keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversation ## Installation ### Pre-requisites + Before proceeding with the installation of Jan from source, ensure that the following software versions are installed on your system: -- Node.js version 20.0.0 or higher + +- Node.js version 20.0.0 or higher - Yarn version 1.22.0 or higher ### Instructions + > **_Note:_** This instruction is tested on MacOS only. 1. Clone the Jan repository from GitHub + ```bash git clone https://github.com/janhq/jan git checkout DESIRED_BRANCH cd jan ``` + 2. Install the required dependencies using Yarn + ```bash yarn install @@ -35,13 +52,17 @@ yarn build:plugins # Packing uikit yarn build:uikit ``` + 3. Run development and using Jan + ```bash yarn dev ``` + This will start the development server and open the desktop app. During this step, you may encounter notifications about installing base plugins. Simply click `OK` and `Next` to continue. #### For production build + Build the app for macOS M1/M2 for production and place the result in the dist folder ```bash @@ -63,4 +84,4 @@ yarn build:uikit yarn build ``` -This completes the installation process for Jan from source. The production-ready app for macOS can be found in the dist folder. \ No newline at end of file +This completes the installation process for Jan from source. The production-ready app for macOS can be found in the dist folder. diff --git a/docs/docs/install/overview.md b/docs/docs/guides/02-installation/README.mdx similarity index 57% rename from docs/docs/install/overview.md rename to docs/docs/guides/02-installation/README.mdx index 3dce1b938..1aa2c5ede 100644 --- a/docs/docs/install/overview.md +++ b/docs/docs/guides/02-installation/README.mdx @@ -1,13 +1,96 @@ --- -title: Overview +title: Installation +slug: /install description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +In this quickstart we'll show you how to: + +- Download the Jan Desktop client - Mac, Windows, Linux, (and toaster) compatible +- Download and customize models +- Import custom models +- Use the local server at port `1337` + +## Setup + +### Installation + +- To download the latest stable release: https://jan.ai/ + +- To download a nightly release (highly unstable but lots of new features): https://github.com/janhq/jan/releases + +- For a detailed installation guide for your operating system, see the following: + + + + [Mac installation guide](/install/mac) + + + [Windows installation guide](/install/windows) + + + [Linux installation guide](/install/linux) + + + +- To build Jan Desktop from scratch (and have the right to tinker!) + + See the [Build from Source](/install/from-source) guide. + +### Working with Models + +Jan provides a list of recommended models to get you started. +You can find them in the in-app Hub. + +1. `cmd + k` and type "hub" to open the Hub. +2. Download your preferred models. +3. `cmd + k` and type "chat" to open the conversation UI and start chatting. +4. Your model may take a few seconds to start up. +5. You can customize the model settings, at each conversation thread level, on the right panel. +6. To change model defaults globally, edit the `model.json` file. See the [Models](/guides/models) guide. + +### Importing Models + +Jan is compatible with all GGUF models. + +For more information on how to import custom models, not found in the Hub, see the [Models](/guides/models) guide. + +## Working with the Local Server + +> This feature is currently under development. So expect bugs! + +Jan runs a local server on port `1337` by default. + +The endpoints are OpenAI compatible. + +See the [API server guide](/guides/server) for more information. + +## Next Steps + +--- + +TODO: Merge this in: + Getting up and running open-source AI models on your own computer with Jan is quick and easy. Jan is lightweight and can run on a variety of hardware and platform versions. Specific requirements tailored to your platform are outlined below. ## Cross platform + A free, open-source alternative to OpenAI that runs on the Linux, macOS, and Windows operating systems. Please refer to the specific guides below for your platform + - [Linux](/install/linux) - [MacOS (Mac Intel Chip and Mac Apple Silicon Chip)](/install/mac) - [Windows](/install/windows) @@ -15,31 +98,41 @@ A free, open-source alternative to OpenAI that runs on the Linux, macOS, and Win ## Requirements for Jan ### Hardware + Jan is a lightweight platform designed for seamless download, storage, and execution of open-source Large Language Models (LLMs). With a small download size of less than 200 MB and a disk footprint of under 300 MB, Jan is optimized for efficiency and should run smoothly on modern hardware. To ensure optimal performance while using Jan and handling LLM models, it is recommended to meet the following system requirements: #### Disk space + - Minimum requirement - - At least 5 GB of free disk space is required to accommodate the download, storage, and management of open-source LLM models. + - At least 5 GB of free disk space is required to accommodate the download, storage, and management of open-source LLM models. - Recommended - - For an optimal experience and to run most available open-source LLM models on Jan, it is recommended to have 10 GB of free disk space. + - For an optimal experience and to run most available open-source LLM models on Jan, it is recommended to have 10 GB of free disk space. #### Random Access Memory (RAM) and Graphics Processing Unit Video Random Access Memory (GPU VRAM) -The amount of RAM on your system plays a crucial role in determining the size and complexity of LLM models you can effectively run. Jan can be utilized on traditional computers where RAM is a key resource. For enhanced performance, Jan also supports GPU acceleration, utilizing the VRAM of your graphics card. + +The amount of RAM on your system plays a crucial role in determining the size and complexity of LLM models you can effectively run. Jan can be utilized on traditional computers where RAM is a key resource. For enhanced performance, Jan also supports GPU acceleration, utilizing the VRAM of your graphics card. #### Relationship between RAM and VRAM Sizes in Relation to LLM Models + The RAM and GPU VRAM requirements are dependent on the size and complexity of the LLM models you intend to run. The following are some general guidelines to help you determine the amount of RAM or VRAM you need to run LLM models on Jan + - 8 GB of RAM: Suitable for running smaller models like 3B models or quantized 7B models - 16 GB of RAM(recommended): This is considered the "minimum usable models" threshold, particularly for 7B models (e.g Mistral 7B, etc) - Beyond 16GB of RAM: Required for handling larger and more sophisticated model, such as 70B models. -### Architecture +### Architecture + Jan is designed to run on muptiple architectures, versatility and widespread usability. The supported architectures include: + #### CPU + - x86: Jan is well-suited for systems with x86 architecture, which is commonly found in traditional desktops and laptops. It ensures smooth performance on a variety of devices using x86 processors. - ARM: Jan is optimized to run efficiently on ARM-based systems, extending compatibility to a broad range of devices using ARM processors. + #### GPU + - NVIDIA: Jan optimizes the computational capabilities of NVIDIA GPUs, achieving efficiency through the utilization of llama.cpp. This strategic integration enhances the performance of Jan, particularly in resource-intensive Language Model (LLM) tasks. Users can expect accelerated processing and improved responsiveness when leveraging the processing capabilities inherent in NVIDIA GPUs. - AMD: Users with AMD GPUs can seamlessly integrate Jan's GPU acceleration, offering a comprehensive solution for diverse hardware configurations and preferences. - ARM64 Mac: Jan seamlessly supports ARM64 architecture on Mac systems, leveraging Metal for efficient GPU operations. This ensures a smooth and efficient experience for users with Apple Silicon Chips, utilizing the power of Metal for optimal performance on ARM64 Mac devices. diff --git a/docs/docs/guides/03-chatting/01-start-thread.md b/docs/docs/guides/03-chatting/01-start-thread.md new file mode 100644 index 000000000..f016745a6 --- /dev/null +++ b/docs/docs/guides/03-chatting/01-start-thread.md @@ -0,0 +1,3 @@ +--- +title: Starting a Thread +--- diff --git a/docs/docs/guides/03-chatting/02-upload-docs.md b/docs/docs/guides/03-chatting/02-upload-docs.md new file mode 100644 index 000000000..1f635e31a --- /dev/null +++ b/docs/docs/guides/03-chatting/02-upload-docs.md @@ -0,0 +1,3 @@ +--- +title: Uploading docs +--- diff --git a/docs/docs/guides/03-chatting/03-upload-images.md b/docs/docs/guides/03-chatting/03-upload-images.md new file mode 100644 index 000000000..69a7ea95a --- /dev/null +++ b/docs/docs/guides/03-chatting/03-upload-images.md @@ -0,0 +1,3 @@ +--- +title: Uploading Images +--- diff --git a/docs/docs/guides/03-chatting/04-manage-history.md b/docs/docs/guides/03-chatting/04-manage-history.md new file mode 100644 index 000000000..9062a15a7 --- /dev/null +++ b/docs/docs/guides/03-chatting/04-manage-history.md @@ -0,0 +1,3 @@ +--- +title: Manage Chat History +--- diff --git a/docs/docs/guides/03-chatting/README.md b/docs/docs/guides/03-chatting/README.md new file mode 100644 index 000000000..731d3a2b6 --- /dev/null +++ b/docs/docs/guides/03-chatting/README.md @@ -0,0 +1,3 @@ +--- +title: Chatting +--- diff --git a/docs/docs/guides/04-using-models/01-install-from-hub.mdx b/docs/docs/guides/04-using-models/01-install-from-hub.mdx new file mode 100644 index 000000000..414e57fa1 --- /dev/null +++ b/docs/docs/guides/04-using-models/01-install-from-hub.mdx @@ -0,0 +1,15 @@ +--- +title: Install Models from the Hub +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- diff --git a/docs/docs/guides/models.mdx b/docs/docs/guides/04-using-models/02-import-manually.mdx similarity index 92% rename from docs/docs/guides/models.mdx rename to docs/docs/guides/04-using-models/02-import-manually.mdx index 756ce45ad..fecb3fa4d 100644 --- a/docs/docs/guides/models.mdx +++ b/docs/docs/guides/04-using-models/02-import-manually.mdx @@ -1,17 +1,5 @@ --- -title: Model Management -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: - [ - Jan AI, - Jan, - ChatGPT alternative, - local AI, - private AI, - conversational AI, - no-subscription fee, - large language model, - ] +title: Import Models Manually --- {/* Imports */} diff --git a/docs/docs/guides/04-using-models/03-customize-models.md b/docs/docs/guides/04-using-models/03-customize-models.md new file mode 100644 index 000000000..21dfeb33f --- /dev/null +++ b/docs/docs/guides/04-using-models/03-customize-models.md @@ -0,0 +1,3 @@ +--- +title: Customize Model Defaults +--- diff --git a/docs/docs/guides/04-using-models/04-package-models.md b/docs/docs/guides/04-using-models/04-package-models.md new file mode 100644 index 000000000..93ca62d6c --- /dev/null +++ b/docs/docs/guides/04-using-models/04-package-models.md @@ -0,0 +1,3 @@ +--- +title: Package & Publish Models +--- diff --git a/docs/docs/guides/04-using-models/README.md b/docs/docs/guides/04-using-models/README.md new file mode 100644 index 000000000..ad958633d --- /dev/null +++ b/docs/docs/guides/04-using-models/README.md @@ -0,0 +1,3 @@ +--- +title: Using Models +--- diff --git a/docs/docs/guides/server.md b/docs/docs/guides/05-using-server/01-server.md similarity index 59% rename from docs/docs/guides/server.md rename to docs/docs/guides/05-using-server/01-server.md index 245428106..ad5345533 100644 --- a/docs/docs/guides/server.md +++ b/docs/docs/guides/05-using-server/01-server.md @@ -1,22 +1,32 @@ --- -title: API Server +title: Connect to Server description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] --- :::warning -This page is under construction. +This page is under construction. ::: -Jan ships with a built-in API server, that can be used as a drop-in replacement for OpenAI's API. +Jan ships with a built-in API server, that can be used as a drop-in replacement for OpenAI's API. -Jan runs on port `1337` by default, but this can be changed in Settings. +Jan runs on port `1337` by default, but this can be changed in Settings. Check out the [API Reference](/api-reference) for more information on the API endpoints. ``` curl https://localhost:1337/v1/chat/completions -``` \ No newline at end of file +``` diff --git a/docs/docs/guides/05-using-server/README.md b/docs/docs/guides/05-using-server/README.md new file mode 100644 index 000000000..500f2bb27 --- /dev/null +++ b/docs/docs/guides/05-using-server/README.md @@ -0,0 +1,3 @@ +--- +title: Using the Local Server +--- diff --git a/docs/docs/guides/06-using-extensions/01-import-extensions.md b/docs/docs/guides/06-using-extensions/01-import-extensions.md new file mode 100644 index 000000000..69cc14cc1 --- /dev/null +++ b/docs/docs/guides/06-using-extensions/01-import-extensions.md @@ -0,0 +1,3 @@ +--- +title: Import Extensions +--- diff --git a/docs/docs/guides/06-using-extensions/02-extension-settings.md b/docs/docs/guides/06-using-extensions/02-extension-settings.md new file mode 100644 index 000000000..6892a4c93 --- /dev/null +++ b/docs/docs/guides/06-using-extensions/02-extension-settings.md @@ -0,0 +1,5 @@ +--- +title: Extension Settings +--- + +TODO: how to configure settings for extensions diff --git a/docs/docs/guides/06-using-extensions/README.md b/docs/docs/guides/06-using-extensions/README.md new file mode 100644 index 000000000..c2221099f --- /dev/null +++ b/docs/docs/guides/06-using-extensions/README.md @@ -0,0 +1,3 @@ +--- +title: Using Extensions +--- diff --git a/docs/docs/guides/quickstart.mdx b/docs/docs/guides/quickstart.mdx deleted file mode 100644 index 1547db78e..000000000 --- a/docs/docs/guides/quickstart.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Quickstart -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: - [ - Jan AI, - Jan, - ChatGPT alternative, - local AI, - private AI, - conversational AI, - no-subscription fee, - large language model, - ] ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -In this quickstart we'll show you how to: - -- Download the Jan Desktop client - Mac, Windows, Linux, (and toaster) compatible -- Download and customize models -- Import custom models -- Use the local server at port `1337` - -## Setup - -### Installation - -- To download the latest stable release: https://jan.ai/ - -- To download a nightly release (highly unstable but lots of new features): https://github.com/janhq/jan/releases - -- For a detailed installation guide for your operating system, see the following: - - - - [Mac installation guide](/install/mac) - - - [Windows installation guide](/install/windows) - - - [Linux installation guide](/install/linux) - - - -- To build Jan Desktop from scratch (and have the right to tinker!) - - See the [Build from Source](/install/from-source) guide. - -### Working with Models - -Jan provides a list of recommended models to get you started. -You can find them in the in-app Hub. - -1. `cmd + k` and type "hub" to open the Hub. -2. Download your preferred models. -3. `cmd + k` and type "chat" to open the conversation UI and start chatting. -4. Your model may take a few seconds to start up. -5. You can customize the model settings, at each conversation thread level, on the right panel. -6. To change model defaults globally, edit the `model.json` file. See the [Models](/guides/models) guide. - -### Importing Models - -Jan is compatible with all GGUF models. - -For more information on how to import custom models, not found in the Hub, see the [Models](/guides/models) guide. - -## Working with the Local Server - -> This feature is currently under development. So expect bugs! - -Jan runs a local server on port `1337` by default. - -The endpoints are OpenAI compatible. - -See the [API server guide](/guides/server) for more information. - -## Next Steps diff --git a/docs/docs/specs/engineering/fine-tuning.md b/docs/docs/specs/engineering/fine-tuning.md deleted file mode 100644 index 111e28f6f..000000000 --- a/docs/docs/specs/engineering/fine-tuning.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Fine-tuning" -slug: /specs/finetuning -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- - -Todo: @hiro diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index a2799552e..23422fda5 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -236,8 +236,8 @@ const config = { { type: "docSidebar", position: "left", - sidebarId: "specsSidebar", - label: "Specs", + sidebarId: "docsSidebar", + label: "Docs", }, // Navbar right { diff --git a/docs/sidebars.js b/docs/sidebars.js index 2e7f7d546..c81d6b663 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -15,81 +15,22 @@ const sidebars = { guidesSidebar: [ { - type: "category", - label: "Introduction", - link: { type: "doc", id: "guides/introduction" }, - collapsible: true, - collapsed: true, - items: ["guides/quickstart"], - }, - { - type: "category", - label: "Installation", - link: { type: "doc", id: "install/overview" }, - collapsible: true, - collapsed: true, - items: [ - "install/windows", - "install/mac", - "install/linux", - "install/from-source", - ], - }, - { - type: "category", - label: "Using Jan", - collapsible: true, - collapsed: true, - items: ["guides/models", "guides/server"], + type: "autogenerated", + dirName: "guides", }, ], developerSidebar: [ { type: "autogenerated", - dirName: "docs", + dirName: "developer", }, ], - specsSidebar: [ + docsSidebar: [ { - type: "category", - label: "Overview", - collapsible: true, - collapsed: false, - items: ["specs/architecture", "specs/file-based", "specs/user-interface"], - }, - { - type: "category", - label: "Product Specs", - collapsible: true, - collapsed: false, - items: [ - "specs/product/chat", - "specs/product/hub", - "specs/product/system-monitor", - "specs/product/settings", - ], - }, - - { - type: "category", - label: "Engineering Specs", - collapsible: true, - collapsed: false, - items: [ - "specs/engineering/chats", - "specs/engineering/models", - "specs/engineering/engine", - "specs/engineering/threads", - "specs/engineering/messages", - "specs/engineering/assistants", - // "specs/engineering/files", - // "specs/engineering/jan", - // "specs/engineering/fine-tuning", - // "specs/engineering/settings", - // "specs/engineering/prompts", - ], + type: "autogenerated", + dirName: "docs", }, ],