Merge pull request #1913 from janhq/function-calling-improvement

Enhanced Function Calling Guide and the main README, removed warnings at different places where Cortex is stable already, and tweaked the images to showcase current functionality without `tensorrt-llm`.

Author: ramonpzg

README.md

@@ -5,10 +5,6 @@ slug: "architecture"
 draft: true
 ---
 
-:::warning
-🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
-:::
-
 ## Introduction
 
 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.

assets/cortex-banner.png

@@ -7,10 +7,6 @@ slug: "cortex-db"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 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.
-:::
 
 ![sqlite-view](/img/sqlite_view_harlequin.png)
 **db view via [Harlequin](https://harlequin.sh/)**

docs/docs/architecture.mdx

@@ -7,10 +7,6 @@ slug: "cortexrc"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 Cortex.cpp is currently under active development. Our documentation outlines the intended behavior of
-Cortex, which may not be fully implemented in the codebase yet.
-:::
 
 Cortex supports using a config-based approach to configuring most of its functionality. During the
 installation process, a `.cortexrc` will be generated with some sensible defaults in it. Using this

docs/docs/architecture/cortex-db.mdx

@@ -7,10 +7,6 @@ slug: "data-folder"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 Cortex.cpp is currently under active development. Our documentation outlines the
-intended behavior of Cortex and some functionality may not be fully implemented yet.
-:::
 
 When you install Cortex.cpp, three types of files will be generated on your device:
 

docs/docs/architecture/cortexrc.mdx

@@ -7,10 +7,6 @@ slug: "updater"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 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.
-:::
 
 This document outlines the architectural design for a C++ updater responsible for downloading and executing
 the installers for the CLI and Server binaries.

docs/docs/architecture/data-folder.mdx

@@ -6,9 +6,6 @@ description: Chat Completions Feature
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
-:::
 
 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.
 
@@ -23,8 +20,8 @@ Cortex routes requests to multiple APIs for remote inference while providing a s
 ## Usage
 ### CLI
 
-```bash 
-# Streaming 
+```bash
+# Streaming
 cortex chat --model mistral
 ```
 ### API

docs/docs/architecture/updater.mdx

@@ -7,11 +7,6 @@ slug: "cors"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 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.
-:::
-
 This document describes how to configure Cross-Origin Resource Sharing (CORS) settings for the API server
 using the CLI commands and the HTTP API endpoints.
 

docs/docs/chat-completions.mdx

@@ -7,10 +7,6 @@ slug: "proxy"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 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.
-:::
 
 # Proxy Configuration Guide
 

docs/docs/configurations/cors.mdx

@@ -7,10 +7,6 @@ slug: "token"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 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.
-:::
 
 A lot of the models available today can be found on HuggingFace. This page describes how to configure
 HuggingFace token settings for Cortex.

docs/docs/configurations/proxy.mdx

@@ -4,10 +4,6 @@ description: Cortex.cpp Architecture
 slug: "cortex-cpp"
 ---
 
-:::warning
-🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
-:::
-
 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/)
 
 Cortex's roadmap is to eventually support full OpenAI API-equivalence.

docs/docs/configurations/token.mdx

@@ -7,9 +7,6 @@ slug: "cortex-llamacpp"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
-:::
 
 :::info
 `llamacpp` is formerly called "Nitro".
@@ -67,9 +64,9 @@ The command will check, download, and install these dependencies:
     - Cuda 12.2:
       - libcublas.so.12
       - libcublasLt.so.12
-      - libcudart.so.12     
+      - libcudart.so.12
     - Cuda 12.4:
-      - libcublasLt.so.12   
+      - libcublasLt.so.12
       - libcublas.so.12
     ```
   </TabItem>

docs/docs/cortex-cpp.md

@@ -7,18 +7,15 @@ slug: "embeddings"
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-:::warning
-🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
-:::
-
 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.
+
 :::note
 The Cortex Embeddings feature is fully compatible with OpenAI's [Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) endpoints.
 :::
 
 ## Usage
 ### CLI
-```bash 
+```bash
 # Without Flag
 cortex embeddings "Hello World"
 # With model_id Flag
@@ -84,4 +81,4 @@ For a complete list of models, please visit the [Cortex Hub](https://huggingface
 Learn more about Embeddings capabilities:
 - [Embeddings API Reference](/api-reference#tag/embeddings/post/embeddings)
 - [Embeddings CLI command](/docs/cli/embeddings)
-:::
+:::