docs: add quickstart

janhq · Dec 12, 2023 · b565c2e · b565c2e
1 parent 121dc11
commit b565c2e
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 4 deletions.
diff --git a/assistants/jan/assistant.json b/assistants/jan/assistant.json
@@ -0,0 +1,11 @@
+{
+  "avatar": "",
+  "id": "jan",
+  "object": "assistant",
+  "created_at": 1702340894030,
+  "name": "Jan",
+  "description": "A default assistant that can use all downloaded models",
+  "model": "*",
+  "instructions": "",
+  "file_ids": []
+}
diff --git a/docs/docs/intro/quickstart.md b/docs/docs/intro/quickstart.md
@@ -1,9 +1,44 @@
 ---
 title: Quickstart
-description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
+description: Jan QuickStart Guide - A Comic Adventure into Self-Hosted AI
 keywords: [Jan AI,  Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ]
 ---
+# QuickStart Guide: A Comic Adventure into Self-Hosted AI
+*Join us on an adventure to explore the world of Jan, your new self-hosted AI companion!*
+
+## Getting Started with Jan
+*Follow these simple steps to get started with Jan and make the most of your AI companion. Let's embark on a whimsical journey to get Jan up and running!*
+
+- **Step 1: Install Jan**: 
+  *Our adventure begins! Follow the [mystical map](/install/overview) to bring Jan on your device.*
+
+- **Step 2: Open the App**: 
+  *Behold the magical portal (chat window)! This is where you'll converse with Jan.*
+
+  ![StartAppUI](/img/docs/StartAppUI.png)
+
+
+- **Step 3: Model Selection**: 
+  *Without a model, Jan is like a wizard without a wand. Journey to the enchanted library (Model) to choose your magical artifact.*
+
+  ![ExploreUI](/img/docs/ExploreHubUI.png)
+
+- **Step 4: Explore the Hub**: 
+  *In the hub, you'll find various scrolls (models) sorted into sections - All Models, Recommended, Downloaded. Each scroll reveals its secrets (model details) to help you decide.*
+
+  ![HubUI](/img/docs/HubUI.png)
+
+- **Step 5: Download and Start**: 
+  *Select your scroll (model), let the magic (download) happen, and begin your dialogues with Jan!*
+
+ ![DownloadUI](/img/docs/DownloadUI.png)
+
+- **Step 6: Start Your First Message with Jan**: 
+  *Now, with the model downloaded, it's time to cast your first spell (send your first message)! Watch as Jan comes to life, ready to chat and assist.*
+
+  ![FirstMessageUI](/img/docs/FirstMessageUI.png)
+
+  *You're all set! Explore, extend, and enjoy your journey with Jan.*
+
+---
 
-- Write in the style of comics, explanation
-- Similar to why's (poignant) Guide to Ruby
-- https://en.wikipedia.org/wiki/Why%27s_(poignant)_Guide_to_Ruby
diff --git a/docs/static/img/docs/DownloadUI.png b/docs/static/img/docs/DownloadUI.png
diff --git a/docs/static/img/docs/ExploreHubUI.png b/docs/static/img/docs/ExploreHubUI.png
diff --git a/docs/static/img/docs/FirstMessageUI.png b/docs/static/img/docs/FirstMessageUI.png
diff --git a/docs/static/img/docs/HubUI.png b/docs/static/img/docs/HubUI.png
diff --git a/docs/static/img/docs/StartAppUI.png b/docs/static/img/docs/StartAppUI.png