Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

New Documentation for Cortex #2192

Open
ramonpzg wants to merge 18 commits into dev
base: dev
Choose a base branch
Loading
from rp/new-docs-site
Open

New Documentation for Cortex #2192

ramonpzg wants to merge 18 commits into dev from rp/new-docs-site

Conversation

@ramonpzg
Copy link
Contributor

@ramonpzg ramonpzg commented Apr 3, 2025
edited
Loading

This PR includes the following

  • New landing page
  • New Model Hub
  • New documentation site

The documentation site follows the Diataxis methodology where the docs are split into 4 sections:

  • How-to, which includes installation, quickstart tutorial, configuration and more
  • Explanations: covers the architecture of cortex and details related to how it handles models, engines, and the server
  • Tutorials: As of now, there are only two tutorials but there is a mini video series coming soon
  • Reference: contains CLI commands and other low level details regarding cortex

The new model hub has two sections, one for cortex with the same models as those in the old website, and a section for selected hugging face models

The recommended way to test the docs is with bun js.

@ramonpzg ramonpzg added the docs Documentation related task label Apr 3, 2025
@ramonpzg ramonpzg added this to the Caffeinated Sloth milestone Apr 3, 2025
@ramonpzg ramonpzg self-assigned this Apr 3, 2025
@ramonpzg ramonpzg added this to Jan and Menlo Apr 3, 2025
Copy link
Contributor

github-actions bot commented Apr 4, 2025
edited
Loading

📝 Documentation Preview: https://menloresearch.github.io/cortex.cpp/

Copy link
Contributor

@vansangpfiev vansangpfiev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments. Should we remove ONNX Runtime in docs since cortex does not support it?

@github-project-automation github-project-automation bot moved this from Investigating to QA in Menlo Apr 4, 2025
Copy link

@selim1903 selim1903 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly docs, so I leave it to Sang to approve. no core code change

ramonpzg reacted with thumbs up emoji
@david-menloai david-menloai added the devrel Developer Relations label Apr 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@david-menloai david-menloai Awaiting requested review from david-menloai

2 more reviewers

@vansangpfiev vansangpfiev vansangpfiev approved these changes

@selim1903 selim1903 selim1903 approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Labels

devrel Developer Relations docs Documentation related task

Projects

Status: No status
Status: QA

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /