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: Desktop Section #186

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

Unclear Docs: Desktop Section #186

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

  • I think we should turn this to "Desktop"
    • Covers full gamut of issues (e.g. uninstallation, data folder location, etc)
  • A lot of missing material in Desktop docs, needs engineers to provide Pena team with context

Todos

Recommended Structure

URL Structure

/docs/desktop (we will draft a more "product-oriented" page
/docs/desktop/windows
/docs/desktop/mac
/docs/desktop/linux

Structure

  • Desktop (page to be added in future)
    • Windows (most used)
    • Mac (2nd most used)
    • Linux (niche)

Desktop (/docs/desktop)

- Should this be a page instead, for Jan Desktop?
- URL should be `/desktop`

Desktop -> Windows (/docs/desktop/windows)

## Prerequisites -> "Compatibility" 
- OS
	- Windows 10
- Hardware
	- CPU?
	- RAM?
	
## Installing Jan
- Downloading (i.e. Stable)
	- Warn user to double check URL
	- https://jan.ai
	- Github
	- (In Future) Windows App Store
- Installing
	- Anything here?
	- Onboarding steps should be referred to here
- Nightly
	- Download from Github (not from Discord!)
- Jan Data Folder
	- Where is it located on Windows?
	- How to move it?
	- Link to the Data Folder page (which will explain contents of data folder in detail)
	
## GPU Acceleration
- Use Headers for this? (vs. Tabs = difficult to link to)
- Nvidia GPU
- AMD GPU
- Intel GPU

## Uninstalling Jan
- Deleting all related files 
- Deleting Jan Data Folder

## Troubleshooting
- Common problems, FAQs go here

Desktop -> Mac (/docs/desktop/mac)

## Prerequisites (should this be "Compatibility?" instead")
- What is the correct name for this section?
- OS
	- Do we need to define what OS versions are supported?
	- We use a Mac Universal (check with Louis, Hien on why we made that decision)
- Hardware
	- Mac Intel (examples of Mac Intels?) 
	- Mac Apple Silicon (i.e. M1, M2, M3)
- [To Move] "Homebrew and its dependencies" -> should go into Homebrew section

## Installing Jan
- Downloading (i.e. Stable)
	- Warn user to double check URL
	- https://jan.ai
	- Github
	- (In Future) Mac App Store
	- Homebrew (Unofficial)
- Installing
	- Onboarding Steps (use step by step)
	- Nightly (separate section)
		- Download from Github (not from Discord!)
		- Needs to include warning that Nightly will crash often
- Data Folder
	- Jan Data Folder: where is it on Mac?
	- How to shift Data Folder
	- Link to the Data Folder page (which will explain contents of data folder in detail)

## Hardware Acceleration
	- This should be a different name (check with @hiento09: is it "Metal"?)
	- I'm very sure you can't activate it using the Settings
	- Apple Silicon should have Metal support by default?
	- Link out to the Apple documentation on Metal
	
## Uninstalling Jan
	- Deleting all related files
	- Deleting Jan Data Folder
	
## Troubleshooting
	- Common problems, FAQs go here

Desktop -> Linux (docs/desktop/linux)

## Prerequisites -> "Compatibility"
- OS
	- Debian -> .deb
	- Fedora -> AppImage
- Hardware
	- CPU
	- RAM

## Installing Jan
- Downloading
	- Official Site
	- Github
- Debian (Ubuntu)
	- Download the .deb
	- dpkg
	- apt-get
- Fedora? (AppImage)
	- Download AppImage
	- Command to install
- Nightly
- Jan Data Folder   
	- Where is it located?
	- How to move it?

## GPU Acceleration
	- Use Headers for this? ( so it's easy to link)
	- Nvidia GPU
	- AMD GPU
	- Intel GPU
	
## Troubleshooting, common problems etc
@dan-jan dan-jan changed the title Unclear Docs: Desktop Installation Unclear Docs: Desktop Section May 6, 2024
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