diff --git a/docs/docs/events/nvidia-llm-day-nov-23.md b/docs/docs/events/nvidia-llm-day-nov-23.md index 33f8ff764..d467dcb6e 100644 --- a/docs/docs/events/nvidia-llm-day-nov-23.md +++ b/docs/docs/events/nvidia-llm-day-nov-23.md @@ -3,7 +3,7 @@ title: "Nov 23: Nvidia GenAI Day" description: Nvidia's LLM Day --- -![](../../static/img/nvidia-llm-day-header.png) +![](/img/nvidia-llm-day-header.png) ## Nvidia GenAI Innovation Day @@ -17,5 +17,5 @@ Jan will be at Nvidia's GenAI Innovation Day in Nov '23, focusing on Enterprise ### Programme -![](../../static/img/nvidia-llm-day.png) +![](/img/nvidia-llm-day.png) diff --git a/docs/docs/features/acceleration.md b/docs/docs/features/acceleration.md deleted file mode 100644 index c6244673b..000000000 --- a/docs/docs/features/acceleration.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Hardware Acceleration ---- \ No newline at end of file diff --git a/docs/docs/features/ai-models.md b/docs/docs/features/ai-models.md deleted file mode 100644 index 08e5bfc3d..000000000 --- a/docs/docs/features/ai-models.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Powerful AI Models ---- - -- Run AI on your own hardware - - Llama2, StableDiffusion - - Rapidly growing ecosystem of open source, locally run AI -- Connect to cloud-based AI - - ChatGPT - - Claude - - Bard \ No newline at end of file diff --git a/docs/docs/features/control.md b/docs/docs/features/control.md deleted file mode 100644 index e3494b108..000000000 --- a/docs/docs/features/control.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Privacy and Data Security ---- - -- Privacy - - Data Security - - Optional Policy Engine for 3rd-party AIs -- Offline-ready - - Airgapped locations -- Prevent a data leak - - Shadow IT - - Personal Information being sent to ChatGPT, corporate IP \ No newline at end of file diff --git a/docs/docs/features/extensions.md b/docs/docs/features/extensions.md deleted file mode 100644 index c73d88f86..000000000 --- a/docs/docs/features/extensions.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Extensions ---- \ No newline at end of file diff --git a/docs/docs/features/features.md b/docs/docs/features/features.md deleted file mode 100644 index d68e9a7ad..000000000 --- a/docs/docs/features/features.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Features ---- \ No newline at end of file diff --git a/docs/docs/features/unlimited.md b/docs/docs/features/unlimited.md deleted file mode 100644 index 8d1a0c843..000000000 --- a/docs/docs/features/unlimited.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Unlimited Use ---- - -- Cost doesn't scale with usage - - Difficult to estimate cost of a project -- ChatGPT costs $2 per GPT-4 call with 32k context (what document would this be equivalent to?) - - Reading in documents is expensive - - Getting ChatGPT to ingest a codebase -- On the other hand - - No surprises at the end of the month - - Use as much as you want - - Predictable costs \ No newline at end of file diff --git a/docs/docs/getting-started/troubleshooting.md b/docs/docs/getting-started/troubleshooting.md deleted file mode 100644 index 815157423..000000000 --- a/docs/docs/getting-started/troubleshooting.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Troubleshooting -sidebar_position: 5 ---- - -# Jan.ai Troubleshooting Guide -Please note that 👋Jan is in "development mode," and you might encounter issues. If you need to reset your installation, follow these steps: - -## Issue 1: Broken Build - -As Jan is development mode, you might get stuck on a broken build. - -To reset your installation: - -1. Delete Jan from your `/Applications` folder - -1. Delete Application data: - ```sh - # Newer versions - rm -rf /Users/$(whoami)/Library/Application\ Support/jan - - # Versions 0.2.0 and older - rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron - ``` - -1. Clear Application cache: - ```sh - rm -rf /Users/$(whoami)/Library/Caches/jan* - ``` - -1. Use the following commands to remove any dangling backend processes: - - ```sh - ps aux | grep nitro - ``` - - Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: - - ```sh - kill -9 - ``` - diff --git a/docs/docs/guide/assistants.md b/docs/docs/guide/assistants.md new file mode 100644 index 000000000..0edc163ba --- /dev/null +++ b/docs/docs/guide/assistants.md @@ -0,0 +1,3 @@ +--- +title: Build an Assistant +--- \ No newline at end of file diff --git a/docs/docs/guide/models.md b/docs/docs/guide/models.md new file mode 100644 index 000000000..9e929b76b --- /dev/null +++ b/docs/docs/guide/models.md @@ -0,0 +1,3 @@ +--- +title: Model Management +--- \ No newline at end of file diff --git a/docs/docs/guide/modules.md b/docs/docs/guide/modules.md new file mode 100644 index 000000000..41a112417 --- /dev/null +++ b/docs/docs/guide/modules.md @@ -0,0 +1,3 @@ +--- +title: Build a Module +--- \ No newline at end of file diff --git a/docs/docs/guide/themes.md b/docs/docs/guide/themes.md new file mode 100644 index 000000000..2d07b30e1 --- /dev/null +++ b/docs/docs/guide/themes.md @@ -0,0 +1,3 @@ +--- +title: Build a Theme +--- \ No newline at end of file diff --git a/docs/docs/guide/tools.md b/docs/docs/guide/tools.md new file mode 100644 index 000000000..3c6c721e4 --- /dev/null +++ b/docs/docs/guide/tools.md @@ -0,0 +1,3 @@ +--- +title: Build a Tool +--- \ No newline at end of file diff --git a/docs/docs/getting-started/install/linux.md b/docs/docs/install/linux.md similarity index 88% rename from docs/docs/getting-started/install/linux.md rename to docs/docs/install/linux.md index 34158cae2..a1020858a 100644 --- a/docs/docs/getting-started/install/linux.md +++ b/docs/docs/install/linux.md @@ -12,7 +12,7 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](../img/jan-download.png) +![Jan Installer](/img/jan-download.png) :::tip @@ -43,22 +43,22 @@ Now, let's get your first model: 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](../img/explore-model.png) +![Explore models](/img/explore-model.png) 3. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](../img/model-version.png) +![Model versions](/img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. 4. Select your preferred model and click "Download." -![Downloading](../img/downloading.png) +![Downloading](/img/downloading.png) ### Step 3: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](../img/start-model.png) +![Start model](/img/start-model.png) ### Step 4: Start the conversations @@ -68,7 +68,7 @@ Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](../img/chat.png) +![Chat](/img/chat.png) That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. diff --git a/docs/docs/getting-started/install/mac.md b/docs/docs/install/mac.md similarity index 55% rename from docs/docs/getting-started/install/mac.md rename to docs/docs/install/mac.md index e3bbc353b..11d499708 100644 --- a/docs/docs/getting-started/install/mac.md +++ b/docs/docs/install/mac.md @@ -10,7 +10,7 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](../img/jan-download.png) +![Jan Installer](/img/jan-download.png) ### Step 2: Download your first model Now, let's get your first model: @@ -19,22 +19,22 @@ Now, let's get your first model: 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](../img/explore-model.png) +![Explore models](/img/explore-model.png) 3. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](../img/model-version.png) +![Model versions](/img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. 4. Select your preferred model and click "Download." -![Downloading](../img/downloading.png) +![Downloading](/img/downloading.png) ### Step 3: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](../img/start-model.png) +![Start model](/img/start-model.png) ### Step 4: Start the conversations Now you're ready to start using 👋Jan.ai for conversations: @@ -43,10 +43,42 @@ Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](../img/chat.png) +![Chat](/img/chat.png) That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. ## Uninstallation -## Troubleshooting \ No newline at end of file +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: + ```sh + # Newer versions + 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: + ```sh + rm -rf /Users/$(whoami)/Library/Caches/jan* + ``` + +4. Use the following commands to remove any dangling backend processes: + + ```sh + ps aux | grep nitro + ``` + + Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: + + ```sh + kill -9 + ``` + +## FAQs diff --git a/docs/docs/getting-started/install/windows.md b/docs/docs/install/windows.md similarity index 86% rename from docs/docs/getting-started/install/windows.md rename to docs/docs/install/windows.md index 6b13841e7..0eafc03dd 100644 --- a/docs/docs/getting-started/install/windows.md +++ b/docs/docs/install/windows.md @@ -10,7 +10,7 @@ To begin using 👋Jan.ai on your Windows computer, follow these steps: 1. Visit [Jan.ai](https://jan.ai/). 2. Click on the "Download for Windows" button to download the Jan Installer. -![Jan Installer](../img/jan-download.png) +![Jan Installer](/img/jan-download.png) ## Step 2: Proceed the Windows Defender @@ -18,11 +18,11 @@ When you run the Jan Installer, Windows Defender may display a warning. Here's w 1. Click "Run away" to accept and install 👋Jan.ai. -![Accept Jan](../img/window-defender.png) +![Accept Jan](/img/window-defender.png) 1. Wait for the 👋Jan.ai installation to complete. -![Setting up](../img/set-up.png) +![Setting up](/img/set-up.png) :::tip @@ -48,22 +48,22 @@ Now, let's get your first model: 2. Welcome to the Jan homepage. Click on "Explore Models" to see the Model catalog. -![Explore models](../img/explore-model.png) +![Explore models](/img/explore-model.png) 1. You can also see different quantized versions by clicking on "Show Available Versions." -![Model versions](../img/model-version.png) +![Model versions](/img/model-version.png) > Note: Choose a model that matches your computer's memory and RAM. 1. Select your preferred model and click "Download." -![Downloading](../img/downloading.png) +![Downloading](/img/downloading.png) ## Step 4: Start the model Once your model is downloaded. Go to "My Models" and then click "Start Model." -![Start model](../img/start-model.png) +![Start model](/img/start-model.png) ## Step 5: Start the conversations Now you're ready to start using 👋Jan.ai for conversations: @@ -72,6 +72,6 @@ Click "Chat" and begin your first conversation by selecting "New conversation." You can also check the CPU and Memory usage of the computer. -![Chat](../img/chat.png) +![Chat](/img/chat.png) That's it! Enjoy using Large Language Models (LLMs) with 👋Jan.ai. \ No newline at end of file diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/intro/how-jan-works.md new file mode 100644 index 000000000..86fe39b32 --- /dev/null +++ b/docs/docs/intro/how-jan-works.md @@ -0,0 +1,3 @@ +--- +title: How Jan Works +--- \ No newline at end of file diff --git a/docs/docs/docs/01_introduction.md b/docs/docs/intro/introduction.md similarity index 100% rename from docs/docs/docs/01_introduction.md rename to docs/docs/intro/introduction.md diff --git a/docs/docs/docs/02_quickstart.md b/docs/docs/intro/quickstart.md similarity index 100% rename from docs/docs/docs/02_quickstart.md rename to docs/docs/intro/quickstart.md diff --git a/docs/docs/specs/architecture.md b/docs/docs/specs/architecture.md new file mode 100644 index 000000000..495ce418d --- /dev/null +++ b/docs/docs/specs/architecture.md @@ -0,0 +1,5 @@ +--- +title: Architecture +--- + +- [ ] Add Architecture Diagram here \ No newline at end of file diff --git a/docs/docs/docs/specs/assistants.md b/docs/docs/specs/assistants.md similarity index 100% rename from docs/docs/docs/specs/assistants.md rename to docs/docs/specs/assistants.md diff --git a/docs/docs/docs/specs/chats.md b/docs/docs/specs/chats.md similarity index 97% rename from docs/docs/docs/specs/chats.md rename to docs/docs/specs/chats.md index fedd6a9c8..fba04ef11 100644 --- a/docs/docs/docs/specs/chats.md +++ b/docs/docs/specs/chats.md @@ -1,5 +1,5 @@ --- -title: "Chats" +title: Chats --- :::warning diff --git a/docs/docs/docs/specs/files.md b/docs/docs/specs/files.md similarity index 100% rename from docs/docs/docs/specs/files.md rename to docs/docs/specs/files.md diff --git a/docs/docs/docs/specs/messages.md b/docs/docs/specs/messages.md similarity index 98% rename from docs/docs/docs/specs/messages.md rename to docs/docs/specs/messages.md index ed5c5d95b..e288c0d5d 100644 --- a/docs/docs/docs/specs/messages.md +++ b/docs/docs/specs/messages.md @@ -1,5 +1,5 @@ --- -title: "Messages" +title: Messages --- :::warning diff --git a/docs/docs/docs/specs/models.md b/docs/docs/specs/models.md similarity index 99% rename from docs/docs/docs/specs/models.md rename to docs/docs/specs/models.md index d04d2b2c3..2276c5f97 100644 --- a/docs/docs/docs/specs/models.md +++ b/docs/docs/specs/models.md @@ -1,5 +1,5 @@ --- -title: "Models" +title: Models --- :::warning diff --git a/docs/docs/docs/specs/threads.md b/docs/docs/specs/threads.md similarity index 99% rename from docs/docs/docs/specs/threads.md rename to docs/docs/specs/threads.md index e7d0fe978..782a270c8 100644 --- a/docs/docs/docs/specs/threads.md +++ b/docs/docs/specs/threads.md @@ -1,5 +1,5 @@ --- -title: "Threads" +title: Threads --- :::warning diff --git a/docs/docs/docs/user-interface.md b/docs/docs/specs/user-interface.md similarity index 97% rename from docs/docs/docs/user-interface.md rename to docs/docs/specs/user-interface.md index cd5079f7e..8085b5b0e 100644 --- a/docs/docs/docs/user-interface.md +++ b/docs/docs/specs/user-interface.md @@ -18,7 +18,7 @@ To Link: ## Views -![Jan Views](./img/jan-views.png) +![Jan Views](/img/jan-views.png) TODO: add a better image. ### Ribbon diff --git a/docs/sidebars.js b/docs/sidebars.js index 7736b60eb..cd5326e28 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -13,64 +13,61 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - featuresSidebar: [ - { - type: "category", - label: "Features", - collapsible: true, - collapsed: false, - link: { type: "doc", id: "features/features" }, - items: [ - "features/ai-models", - "features/control", - "features/acceleration", - "features/extensions", - ], - }, - ], - docsSidebar: [ { type: "category", - label: "Getting Started", - collapsible: false, + label: "Introduction", + link: { type: "doc", id: "intro/introduction" }, + collapsible: true, + collapsed: false, + items: ["intro/quickstart", "intro/how-jan-works"], + }, + { + type: "category", + label: "Installation", + collapsible: true, + collapsed: false, + items: ["install/windows", "install/mac", "install/linux"], + }, + { + type: "category", + label: "Using Jan", + collapsible: true, + collapsed: false, + items: ["guide/models"], + }, + { + type: "category", + label: "Extending Jan", + collapsible: true, collapsed: false, items: [ - "docs/introduction", - { - type: "category", - label: "Installation", - collapsible: true, - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "getting-started/install", - }, - ], - }, - "docs/quickstart", + "guide/assistants", + "guide/themes", + "guide/tools", + "guide/modules", ], }, { type: "category", label: "Building Jan", - collapsible: false, + collapsible: true, collapsed: false, items: [ - "docs/user-interface", + "specs/architecture", { type: "category", label: "Specifications", collapsible: true, - collapsed: true, + collapsed: false, items: [ - "docs/specs/chats", - "docs/specs/models", - "docs/specs/threads", - "docs/specs/messages", - "docs/specs/assistants", - "docs/specs/files", + "specs/user-interface", + "specs/chats", + "specs/models", + "specs/threads", + "specs/messages", + "specs/assistants", + "specs/files", ], }, ], diff --git a/docs/docs/getting-started/img/chat.png b/docs/static/img/chat.png similarity index 100% rename from docs/docs/getting-started/img/chat.png rename to docs/static/img/chat.png diff --git a/docs/docs/getting-started/img/downloading.png b/docs/static/img/downloading.png similarity index 100% rename from docs/docs/getting-started/img/downloading.png rename to docs/static/img/downloading.png diff --git a/docs/docs/getting-started/img/explore-model.png b/docs/static/img/explore-model.png similarity index 100% rename from docs/docs/getting-started/img/explore-model.png rename to docs/static/img/explore-model.png diff --git a/docs/docs/getting-started/img/jan-download.png b/docs/static/img/jan-download.png similarity index 100% rename from docs/docs/getting-started/img/jan-download.png rename to docs/static/img/jan-download.png diff --git a/docs/docs/docs/img/jan-views.png b/docs/static/img/jan-views.png similarity index 100% rename from docs/docs/docs/img/jan-views.png rename to docs/static/img/jan-views.png diff --git a/docs/docs/getting-started/img/model-catelog.png b/docs/static/img/model-catelog.png similarity index 100% rename from docs/docs/getting-started/img/model-catelog.png rename to docs/static/img/model-catelog.png diff --git a/docs/docs/getting-started/img/model-version.png b/docs/static/img/model-version.png similarity index 100% rename from docs/docs/getting-started/img/model-version.png rename to docs/static/img/model-version.png diff --git a/docs/docs/getting-started/img/set-up.png b/docs/static/img/set-up.png similarity index 100% rename from docs/docs/getting-started/img/set-up.png rename to docs/static/img/set-up.png diff --git a/docs/docs/getting-started/img/start-model.png b/docs/static/img/start-model.png similarity index 100% rename from docs/docs/getting-started/img/start-model.png rename to docs/static/img/start-model.png diff --git a/docs/docs/getting-started/img/window-defender.png b/docs/static/img/window-defender.png similarity index 100% rename from docs/docs/getting-started/img/window-defender.png rename to docs/static/img/window-defender.png