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

Unclear Docs: Quickstart #185

Open
3 tasks
dan-jan opened this issue May 6, 2024 · 0 comments
Open
3 tasks

Unclear Docs: Quickstart #185

dan-jan opened this issue May 6, 2024 · 0 comments
Assignees

Comments

@dan-jan
Copy link
Contributor

dan-jan commented May 6, 2024

Current Issues

  • Quickstart misses out on GPU Setup
  • Quickstart's "Best Practices" section is "empty words" (i.e. doesn't really help anything)

Todos

Recommended Structure

## Getting Started

### Step 1: Install Jan

- Talk about how Jan can run on Desktop, or on Server-side
- Should show the "Default state" of the first-installed Jan app (without any models)

### Step 2: Turn on GPU Acceleration (optional)

- Turn on GPU acceleration in Settings
- Ensure they install GPU drivers

### Step 3: Download a Model

- I would keep the "Configure Model" steps as part of Download a model
- I would actually not recommend us include this as part of Quickstart (should just go with defaults)
- In the future, the Right Panel will be hidden

### Step 4: Start Thread

- We should use "Start Thread", vs. "Start Model"
- Model operations will be completely hidden from user in the longer-term

### Step 5: Amend the "Assistant" Instruction

- Try with different assistant prompts
- Warn user that they NEED to have an instruct prompt

### Step 6: Connect to a Remote API

- Jan can also be used with Remote AI APIs
- As long as they are OpenAI-compatible
- We have a bunch of Extensions that allow remote 
- Point user to Settings, ask them to Install the Extension

## Best Practices (to deprecate)

- In my opinion this entire section is not well written and should be deleted
- Quickstart Guide (why is this still here?)
- Selecting the Right Models = this is filler text, delete it

## What to try next?

- Setting up Jan
- Integrations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants