janhq / cortex-web

2 stars 1 forks source link

docs: refactor installation guide #68

Open 0xSage opened 5 days ago

0xSage commented 5 days ago

Let's separate installation from requirements. The current hardware/install guides are a bit all over the place and conflate the two

Design:

  1. Guides should be driven by the user's OS. This is the starting point for most people. Like "ok I have a windows with x cpu, and y gpus, what do i need"

  2. Requirements guide should address dependencies, i.e. if users wanted to chck if they have proper deps. This is because we auto-install things now, we need to be transparent about what exact requirements are.

Suggested refactoring

Installation

Refactor Prerequisites section into Requirements pages.

Everything else, keep as is.


Requirements

Hardware Requirements

CPU, Disk, RAM, all that (in tabs)

Should cover stuff like:

OS Requirements

Mac, Windows, LInux (in tabs)

Should cover stuff like:

GPU Requirements

NVIDIA, AMD, Silicon, Snapdragon NPU, etc. (in tabs)

Should cover stuff like:

irfanpena commented 1 day ago

Added the first cut of the requirements page. Will keep the issue up for tracking