Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add quickstart #946

Closed
wants to merge 10 commits into from
30 changes: 26 additions & 4 deletions docs/docs/guides/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
---
title: Quickstart
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
description: Jan QuickStart Guide - A Gateway to Self-Hosted AI
keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ]
---
# Quickstart Guide: A Gateway to Self-Hosted AI
Start your journey using Jan with this set of quickstart instructions.

- Step 1: Launch Jan's application to access the chat interface.

![StartAppUI](/img/docs/StartAppUI.webp)

- Step 2: Choose an AI model suited to your needs from the Model section.

![ExploreUI](/img/docs/ExploreHubUI.webp)

- Step 3: The Hub displays model information such as description, author, model ID, model size, tags, and format. Users should select models based on their preferences. Models are categorized into 'All Models', 'Downloaded', and 'Recommended'.

![HubUI](/img/docs/HubUI.webp)

- Step 4: Download and start using the model.

![DownloadUI](/img/docs/DownloadUI.webp)

- Step 5: Start Your First Message with Jan

![FirstMessageUI](/img/docs/FirstMessageUI.webp)

*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
Binary file added docs/static/img/docs/DownloadUI.webp
Binary file not shown.
Binary file added docs/static/img/docs/ExploreHubUI.webp
Binary file not shown.
Binary file added docs/static/img/docs/FirstMessageUI.webp
Binary file not shown.
Binary file added docs/static/img/docs/HubUI.webp
Binary file not shown.
Binary file added docs/static/img/docs/StartAppUI.webp
Binary file not shown.