Skip to content

docs: Sprint 21 docs updates #1243

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

Closed
9 tasks
dan-menlo opened this issue Sep 18, 2024 · 2 comments · Fixed by menloresearch/cortex.so#200, menloresearch/cortex.so#201 or menloresearch/cortex.so#202
Closed
9 tasks
Assignees
Labels
type: docs Improvements or additions to documentation
Milestone

Comments

@dan-menlo
Copy link
Contributor

dan-menlo commented Sep 18, 2024

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

@dan-menlo dan-menlo added this to Menlo Sep 18, 2024
@dan-menlo dan-menlo converted this from a draft issue Sep 18, 2024
@dan-menlo dan-menlo assigned irfanpena and unassigned hiento09 Sep 18, 2024
@dan-menlo dan-menlo added the type: docs Improvements or additions to documentation label Sep 18, 2024
@dan-menlo dan-menlo added this to the v0.1 milestone Sep 18, 2024
@dan-menlo dan-menlo changed the title docs: .cortexrc, engines, model folder docs: Sprint 20 docs updates Sep 18, 2024
@irfanpena
Copy link
Contributor

@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-menlo
Copy link
Contributor Author

dan-menlo commented Sep 29, 2024

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

@gabrielle-ong gabrielle-ong changed the title docs: Sprint 20 docs updates docs: Sprint 21 docs updates Oct 1, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Review + QA in Menlo Oct 3, 2024
@gabrielle-ong gabrielle-ong moved this from Review + QA to Completed in Menlo Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment