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

Commit 267403e

Browse files
authored
Merge pull request #1612 from janhq/d/cortex-docs-structure
Refactor Cortex Docs structure
2 parents 5802113 + 58be664 commit 267403e

36 files changed

+220
-386
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: cortex.db
3+
---
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ The main directory that stores all Cortex-related files, located in the user's h
132132
#### `models/`
133133
Contains the AI models used by Cortex for processing and generating responses.
134134
:::info
135-
For more information regarding the `model.list` and `model.yaml`, please see [here](/docs/model-yaml).
135+
For more information regarding the `model.list` and `model.yaml`, please see [here](/docs/capabilities/models/model-yaml).
136136
:::
137137
#### `logs/`
138138
Stores log files that are essential for troubleshooting and monitoring the performance of the Cortex.cpp API server and CLI.

docs/docs/assistants/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Assistants
3+
---
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Tools
3+
---
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
---
2-
title: API
2+
title: API Server
33
description: Cortex Server Overview.
4-
slug: "server"
54
---
65

76
import Tabs from "@theme/Tabs";
87
import TabItem from "@theme/TabItem";
98

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-
149
Cortex has an [API server](https://cortex.so/api-reference) that runs at `localhost:39281`.
1510

1611

docs/docs/basic-usage/command-line.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

docs/docs/basic-usage/integration/js-library.md renamed to docs/docs/basic-usage/cortex-js.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
---
22
title: cortex.js
3-
description: How to integrate cortex.js with a Typescript application.
4-
slug: "ts-library"
3+
description: How to use the Cortex.js Library
54
---
65

6+
[Cortex.js](https://github.com/janhq/cortex.js) is a Typescript client library that can be used to interact with the Cortex API.
7+
8+
This is still a work in progress, and we will let the community know once a stable version is available.
9+
10+
:::warning
11+
🚧 Cortex.js is currently under development, and this page is a stub for future development.
12+
:::
13+
14+
15+
<!--
716
:::warning
817
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
918
:::
@@ -61,4 +70,4 @@ async function inference() {
6170
}
6271
6372
inference();
64-
```
73+
``` -->

docs/docs/basic-usage/integration/py-library.md renamed to docs/docs/basic-usage/cortex-py.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
---
22
title: cortex.py
33
description: How to integrate cortex.py with a Python application.
4-
slug: "py-library"
54
---
65

6+
7+
:::warning
8+
🚧 Cortex.py is currently under development, and this page is a stub for future development.
9+
:::
10+
11+
12+
<!--
713
:::warning
814
🚧 Cortex.cpp is currently under development. Our documentation outlines the intended behavior of Cortex, which may not yet be fully implemented in the codebase.
915
:::
@@ -51,4 +57,4 @@ completion = client.chat.completions.create(
5157
],
5258
)
5359
print(completion.choices[0].message.content)
54-
```
60+
``` -->
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview
3-
description: Overview.
3+
description: Cortex Overview
44
slug: "basic-usage"
55
---
66

0 commit comments

Comments
 (0)