janhq / cortex.cpp

Local AI API Platform
https://cortex.so
Apache License 2.0
2.08k stars 117 forks source link

docs: Sprint 21 docs updates #1243

Closed dan-homebrew closed 1 month ago

dan-homebrew commented 1 month ago

Structure

One idea for Docs is:

# GET STARTED
Overview
Quickstart (should be expanded, and link to most other sections)
Installation

# BASIC USAGE
Overview (should emphasize API server usage)
.cortexrc
model.yaml
Data Folder (covers where Cortex stores its files)
/libraries
    cortex.js
    cortex.py
/Model Sources
    Huggingface
    Cortex Hub
/Engines
    llama.cpp
    TensorRT-LLM
    ONNX

# CLI
...

Tasklist

irfanpena commented 1 month ago

@dan-homebrew For Beta and Nightly version, I am not really sure that we should also provide commands for each version, as the users supposedly and encouraged to use the Stable version.

dan-homebrew commented 1 month ago

@gabrielle-ong I am transferring this issue to you for Sprint 21, please review existing PRs and merge it to https://cortex.so.