Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit b21d964

Browse files
committed
removed active development warning
1 parent 7e7eba8 commit b21d964

20 files changed

+26
-106
lines changed

docs/docs/architecture.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ slug: "architecture"
55
draft: true
66
---
77

8-
:::warning
9-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
10-
:::
11-
128
## Introduction
139

1410
Cortex is a C++ AI engine designed to operate entirely on your local hardware infrastructure. This headless backend platform is also engineered to support TensorRT-LLM, ensuring high-performance machine-learning model execution. It is packaged with a Docker-inspired command-line interface and a Typescript client library.

docs/docs/architecture/cortex-db.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "cortex-db"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior
12-
of Cortex, which may not yet be fully implemented in the codebase.
13-
:::
1410

1511
![sqlite-view](/img/sqlite_view_harlequin.png)
1612
**db view via [Harlequin](https://harlequin.sh/)**

docs/docs/architecture/cortexrc.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "cortexrc"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
12-
Cortex, which may not be fully implemented in the codebase yet.
13-
:::
1410

1511
Cortex supports using a config-based approach to configuring most of its functionality. During the
1612
installation process, a `.cortexrc` will be generated with some sensible defaults in it. Using this

docs/docs/architecture/data-folder.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "data-folder"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the
12-
intended behavior of Cortex and some functionality may not be fully implemented yet.
13-
:::
1410

1511
When you install Cortex.cpp, three types of files will be generated on your device:
1612

docs/docs/architecture/updater.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "updater"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
12-
Cortex, which may not yet be fully implemented in the codebase.
13-
:::
1410

1511
This document outlines the architectural design for a C++ updater responsible for downloading and executing
1612
the installers for the CLI and Server binaries.

docs/docs/chat-completions.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ description: Chat Completions Feature
66
import Tabs from "@theme/Tabs";
77
import TabItem from "@theme/TabItem";
88

9-
:::warning
10-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
11-
:::
129

1310
Cortex's Chat API is compatible with OpenAI’s [Chat Completions](https://platform.openai.com/docs/api-reference/chat) endpoint. It is a drop-in replacement for local inference.
1411

@@ -23,8 +20,8 @@ Cortex routes requests to multiple APIs for remote inference while providing a s
2320
## Usage
2421
### CLI
2522

26-
```bash
27-
# Streaming
23+
```bash
24+
# Streaming
2825
cortex chat --model mistral
2926
```
3027
### API

docs/docs/configurations/cors.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ slug: "cors"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
12-
Cortex, which may not yet be fully implemented in the codebase.
13-
:::
14-
1510
This document describes how to configure Cross-Origin Resource Sharing (CORS) settings for the API server
1611
using the CLI commands and the HTTP API endpoints.
1712

docs/docs/configurations/proxy.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "proxy"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended
12-
behavior of Cortex, which may not yet be fully implemented in the codebase.
13-
:::
1410

1511
# Proxy Configuration Guide
1612

docs/docs/configurations/token.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ slug: "token"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
12-
Cortex, which may not yet be fully implemented in the codebase.
13-
:::
1410

1511
A lot of the models available today can be found on HuggingFace. This page describes how to configure
1612
HuggingFace token settings for Cortex.

docs/docs/cortex-cpp.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ description: Cortex.cpp Architecture
44
slug: "cortex-cpp"
55
---
66

7-
:::warning
8-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
9-
:::
10-
117
Cortex.cpp is a Local AI engine that is used to run and customize LLMs. Cortex can be deployed as a standalone server, or integrated into apps like [Jan.ai](https://jan.ai/)
128

139
Cortex's roadmap is to eventually support full OpenAI API-equivalence.

docs/docs/cortex-llamacpp.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ slug: "cortex-llamacpp"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
1310

1411
:::info
1512
`llamacpp` is formerly called "Nitro".
@@ -67,9 +64,9 @@ The command will check, download, and install these dependencies:
6764
- Cuda 12.2:
6865
- libcublas.so.12
6966
- libcublasLt.so.12
70-
- libcudart.so.12
67+
- libcudart.so.12
7168
- Cuda 12.4:
72-
- libcublasLt.so.12
69+
- libcublasLt.so.12
7370
- libcublas.so.12
7471
```
7572
</TabItem>

docs/docs/embeddings.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,15 @@ slug: "embeddings"
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
1410
An embedding is a vector that represents a piece of text, with the distance between vectors indicating similarity, which means closer distances mean more similar texts, while farther distances mean less similar texts.
11+
1512
:::note
1613
The Cortex Embeddings feature is fully compatible with OpenAI's [Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) endpoints.
1714
:::
1815

1916
## Usage
2017
### CLI
21-
```bash
18+
```bash
2219
# Without Flag
2320
cortex embeddings "Hello World"
2421
# With model_id Flag
@@ -84,4 +81,4 @@ For a complete list of models, please visit the [Cortex Hub](https://huggingface
8481
Learn more about Embeddings capabilities:
8582
- [Embeddings API Reference](/api-reference#tag/embeddings/post/embeddings)
8683
- [Embeddings CLI command](/docs/cli/embeddings)
87-
:::
84+
:::

docs/docs/installation.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@ import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99
import Admonition from '@theme/Admonition';
1010

11-
:::warning
12-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in our codebase.
13-
:::
14-
15-
## Cortex.cpp Installation
16-
1711
### Cortex.cpp offers four installer types
12+
1813
- **Network Installers** download a minimal script and require an internet connection to fetch packages during installation.
1914
- **Local Installers** include all necessary packages, enabling offline installation without internet access.
2015
- **Dockerfile** Installers are used to build a Docker image with Cortex ready to go.
@@ -46,7 +41,7 @@ For other versions, please look at [cortex.cpp repo](https://github.com/janhq/co
4641
### OS
4742
- MacOS 12 or later
4843
- Windows 10 or later
49-
- Linux: Ubuntu 20.04 or later, Debian 11 or later, and any of the latest versions of Arch (for other distributions,
44+
- Linux: Ubuntu 20.04 or later, Debian 11 or later, and any of the latest versions of Arch (for other distributions,
5045
please use the Dockerfile installer or binary files, we have not tested on other distributions yet.)
5146

5247
### Hardware

docs/docs/installation/docker.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ import Tabs from '@theme/Tabs';
77
import TabItem from '@theme/TabItem';
88
import Admonition from '@theme/Admonition';
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended
12-
behavior of Cortex, which may not yet be fully implemented in the codebase.
13-
:::
1410

1511
## Getting Started with Cortex on Docker
1612

docs/docs/installation/linux.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,14 @@ import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99
import Admonition from '@theme/Admonition';
1010

11-
:::warning
12-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended
13-
behavior of Cortex, which may not yet be fully implemented in the codebase yet.
14-
:::
1511

16-
## Cortex.cpp Installation
1712
:::info
1813
Before installation, make sure that you have met the [minimum requirements](/docs/installation#minimum-requirements) to run Cortex.
1914
This instruction is for stable releases. For beta and nightly releases, please replace `cortex` with `cortex-beta` and `cortex-nightly`, respectively.
2015
:::
2116

2217
### Prerequisites
18+
2319
- OpenMPI
2420
- curl
2521
- jq
@@ -52,7 +48,9 @@ This instruction is for stable releases. For beta and nightly releases, please r
5248
```
5349

5450
### Data Folder
51+
5552
By default, Cortex.cpp is installed in the following directory:
53+
5654
```
5755
# Binary Location
5856
/usr/bin/cortex
@@ -66,6 +64,7 @@ By default, Cortex.cpp is installed in the following directory:
6664
```
6765

6866
## Uninstall Cortex.cpp
67+
6968
```bash
7069
# Stable version
7170
sudo /usr/bin/cortex-uninstall.sh

docs/docs/installation/mac.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ slug: 'mac'
77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
14-
## Cortex.cpp Installation
1510
:::info
1611
Before installation, make sure that you have met the [minimum requirements](/docs/installation#minimum-requirements) to run Cortex.
1712
The instructions below are for stable releases only. For beta and nightly releases, please replace `cortex` with `cortex-beta` and `cortex-nightly`, respectively.
@@ -117,7 +112,7 @@ The script requires sudo permission.
117112

118113
## Update Cortex
119114

120-
Cortex can be updated in-place without any additional scripts. In addition, cortex will let you know if there is a new version of itself the next
115+
Cortex can be updated in-place without any additional scripts. In addition, cortex will let you know if there is a new version of itself the next
121116
time you start a server.
122117

123118
:::info
@@ -126,4 +121,4 @@ The script requires sudo permission.
126121

127122
```bash
128123
sudo cortex update
129-
```
124+
```

docs/docs/installation/windows.mdx

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,15 @@ import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99
import Admonition from '@theme/Admonition';
1010

11-
:::warning
12-
🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
13-
Cortex, which may not yet be fully implemented in the codebase.
14-
:::
1511

16-
## Overview
17-
For Windows, Cortex.cpp can be installed in two ways, by downloading the [windows](#windows) installer or
12+
For Windows, Cortex.cpp can be installed in two ways, by downloading the [windows](#windows) installer or
1813
via the [Windows Subsystem for Linux (WSL)](#windows-subsystem-linux).
1914

2015
## Windows
2116
### Install Cortex.cpp
2217
:::info
2318
Before installation, make sure that you have met the [minimum requirements](/docs/installation#minimum-requirements) to run Cortex.
24-
The instructions below are for stable releases only. For beta and nightly releases, please replace `cortex` with `cortex-beta`
19+
The instructions below are for stable releases only. For beta and nightly releases, please replace `cortex` with `cortex-beta`
2520
and `cortex-nightly`, respectively.
2621
:::
2722

@@ -63,7 +58,7 @@ To uninstall Cortex.cpp:
6358

6459
## Windows Subsystem Linux
6560
:::info
66-
Windows Subsystem Linux allows running Linux tools and workflows seamlessly alongside Windows applications. For more
61+
Windows Subsystem Linux allows running Linux tools and workflows seamlessly alongside Windows applications. For more
6762
information, please see this [article](https://learn.microsoft.com/en-us/windows/wsl/faq).
6863
:::
6964

@@ -104,4 +99,4 @@ Follow the [linux installation steps](linux) to install Cortex.cpp on the WSL.
10499
## Update cortex to latest version
105100
```bash
106101
cortex.exe update
107-
```
102+
```

docs/docs/quickstart.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
99

1010

11-
:::info
12-
Cortex.cpp is in active development. If you have any questions, please reach out to us:
13-
- [GitHub](https://github.com/janhq/cortex.cpp/issues/new/choose)
14-
- [Discord](https://discord.com/invite/FTk2MvZwJH)
15-
:::
16-
1711
## Local Installation
1812

1913
Cortex has a **Local Installer** with all of the required dependencies, so that once you've downloaded it, no internet connection is required during the installation process.

docs/docs/requirements.mdx

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ import Tabs from '@theme/Tabs';
77
import TabItem from '@theme/TabItem';
88
import Admonition from '@theme/Admonition';
99

10-
:::warning
11-
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
12-
:::
13-
1410
To run LLMs on-device or on-premise, Cortex has the following requirements:
1511

1612
## Hardware Requirements
@@ -42,21 +38,21 @@ To run LLMs on-device or on-premise, Cortex has the following requirements:
4238
- 8GB for running up to 3B models (int4).
4339
- 16GB for running up to 7B models (int4).
4440
- 32GB for running up to 13B models (int4).
45-
<Admonition type="info">
41+
<Admonition type="info">
4642
We support DDR2 RAM as the minimum requirement but recommend using newer generations of RAM for improved performance.
4743
</Admonition>
4844
</TabItem>
4945
<TabItem value="GPU" label="GPU">
5046
- 6GB can load the 3B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
5147
- 8GB can load the 7B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
5248
- 12GB can load the 13B model (int4) with `ngl` at 120 ~ full speed on CPU/ GPU.
53-
<Admonition type="info">
49+
<Admonition type="info">
5450
Having at least 6GB VRAM when using NVIDIA, AMD, or Intel Arc GPUs is recommended.
5551
</Admonition>
5652
</TabItem>
5753
<TabItem value="Disk" label="Disk">
5854
- Having at least 10GB is recommended.
59-
<Admonition type="info">
55+
<Admonition type="info">
6056
The app is 1.02 MB, but models are usually 4GB+.
6157
</Admonition>
6258
</TabItem>
@@ -116,7 +112,7 @@ To run LLMs on-device or on-premise, Cortex has the following requirements:
116112
<TabItem value="nvidia" label="NVIDIA">
117113
- [NVIDIA driver](https://www.nvidia.com/Download/index.aspx) version 470.63.01 or higher.
118114
- [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) version 12.3 or higher.
119-
<Admonition type="info">
115+
<Admonition type="info">
120116
CUDA Toolkit dependencies will be installed when you install Cortex.
121117
</Admonition>
122118
</TabItem>
@@ -137,4 +133,4 @@ To run LLMs on-device or on-premise, Cortex has the following requirements:
137133
</TabItem>
138134
</Tabs>
139135
</TabItem>
140-
</Tabs>
136+
</Tabs>

0 commit comments

Comments
 (0)