11// @ts -check
22import { defineConfig } from "astro/config" ;
33import starlight from "@astrojs/starlight" ;
4+ import starlightUtils from "@lorenzo_lewis/starlight-utils" ;
45
56// https://astro.build/config
67export default defineConfig ( {
@@ -17,45 +18,193 @@ export default defineConfig({
1718 linkedin : "https://github.com/menloresearch/cortex.cpp" ,
1819 } ,
1920 sidebar : [
21+ {
22+ label : "Title Bar" ,
23+ items : [
24+ { label : "Docs" , link : "overview" } ,
25+ { label : "Model Hub" , link : "../pages/index" } ,
26+ ] ,
27+ } ,
2028 { label : "Welcome" , slug : "overview" } ,
2129 {
2230 label : "Get Started" ,
2331 items : [
24- // Each item here is one entry in the navigation menu.
25-
2632 { label : "Quickstart" , slug : "getting-started/quickstart" } ,
2733 {
2834 label : "Installation" ,
2935 items : [
3036 {
31- label : "Install " ,
37+ label : "Overview " ,
3238 slug : "getting-started/installation/installation" ,
3339 } ,
3440 {
3541 label : "Docker" ,
3642 slug : "getting-started/installation/docker" ,
3743 } ,
44+ { label : "Linux" , slug : "getting-started/installation/linux" } ,
45+ { label : "macOS" , slug : "getting-started/installation/mac" } ,
46+ {
47+ label : "Windows" ,
48+ slug : "getting-started/installation/windows" ,
49+ } ,
50+ ] ,
51+ } ,
52+ { label : "Requirements" , slug : "requirements" } ,
53+ { label : "Basic Usage" , slug : "basic-usage" } ,
54+ { label : "Using Models" , slug : "using-models" } ,
55+ { label : "Troubleshooting" , slug : "troubleshooting" } ,
56+ ] ,
57+ } ,
58+ {
59+ label : "Features" ,
60+ items : [
61+ { label : "Chat Completions" , slug : "chat-completions" } ,
62+ {
63+ label : "Capabilities" ,
64+ items : [
65+ {
66+ label : "Text Generation" ,
67+ slug : "capabilities/text-generation" ,
68+ } ,
69+ { label : "Embeddings" , slug : "capabilities/embeddings" } ,
70+ ] ,
71+ } ,
72+ {
73+ label : "Assistants" ,
74+ slug : "assistants" ,
75+ items : [ { label : "Tools" , slug : "assistants/tools" } ] ,
76+ } ,
77+ ] ,
78+ } ,
79+ {
80+ label : "Models" ,
81+ items : [
82+ { label : "Overview" , slug : "capabilities/models" } ,
83+ { label : "Model YAML" , slug : "capabilities/models/model-yaml" } ,
84+ {
85+ label : "Model Sources" ,
86+ items : [
87+ { label : "Overview" , slug : "capabilities/models/sources" } ,
88+ {
89+ label : "Cortex Hub" ,
90+ slug : "capabilities/models/sources/cortex-hub" ,
91+ } ,
92+ {
93+ label : "Hugging Face" ,
94+ slug : "capabilities/models/sources/hugging-face" ,
95+ } ,
96+ {
97+ label : "NVIDIA NGC" ,
98+ slug : "capabilities/models/sources/nvidia-ngc" ,
99+ } ,
38100 ] ,
39101 } ,
40- // { label: "Docker", slug: "getting-started/installation/docker" },
41- // { label: "Overview", slug: "overview" },
42- // { label: "Overview", slug: "overview" },
43- // { label: "Overview", slug: "overview" },
44- // { label: "Overview", slug: "overview" },
102+ { label : "Hardware" , slug : "capabilities/hardware" } ,
103+ ] ,
104+ } ,
105+ {
106+ label : "CLI" ,
107+ items : [
108+ { label : "Overview" , slug : "cli/cortex" } ,
109+ { label : "Run" , slug : "cli/run" } ,
110+ { label : "Start" , slug : "cli/start" } ,
111+ { label : "Stop" , slug : "cli/stop" } ,
112+ { label : "PS" , slug : "cli/ps" } ,
113+ { label : "Serve" , slug : "cli/serve" } ,
114+ { label : "Pull" , slug : "cli/pull" } ,
115+ { label : "Update" , slug : "cli/update" } ,
116+ { label : "Benchmark" , slug : "cli/benchmark" } ,
117+ // { label: "Embeddings", slug: "cli/embeddings" },
118+ { label : "Presets" , slug : "cli/presets" } ,
119+ { label : "Config" , slug : "cli/config" } ,
120+ { label : "Telemetry" , slug : "cli/telemetry" } ,
121+ {
122+ label : "Models" ,
123+ items : [
124+ { label : "Overview" , slug : "cli/models" } ,
125+ { label : "List" , slug : "cli/models/list" } ,
126+ { label : "Get" , slug : "cli/models/get" } ,
127+ { label : "Download" , slug : "cli/models/download" } ,
128+ { label : "Start" , slug : "cli/models/start" } ,
129+ { label : "Stop" , slug : "cli/models/stop" } ,
130+ { label : "Update" , slug : "cli/models/update" } ,
131+ { label : "Remove" , slug : "cli/models/remove" } ,
132+ ] ,
133+ } ,
134+ {
135+ label : "Configs" ,
136+ items : [
137+ { label : "Overview" , slug : "cli/configs" } ,
138+ { label : "List" , slug : "cli/configs/list" } ,
139+ { label : "Get" , slug : "cli/configs/get" } ,
140+ { label : "Set" , slug : "cli/configs/set" } ,
141+ ] ,
142+ } ,
143+ {
144+ label : "Engines" ,
145+ items : [
146+ { label : "Overview" , slug : "cli/engines" } ,
147+ { label : "List" , slug : "cli/engines/list" } ,
148+ { label : "Get" , slug : "cli/engines/get" } ,
149+ { label : "Init" , slug : "cli/engines/init" } ,
150+ ] ,
151+ } ,
152+ {
153+ label : "Hardware" ,
154+ slug : "cli/hardware" ,
155+ } ,
156+ ] ,
157+ } ,
158+ {
159+ label : "Configurations" ,
160+ items : [
161+ { label : "Overview" , slug : "configurations" } ,
162+ { label : "CORS" , slug : "configurations/cors" } ,
163+ { label : "Proxy" , slug : "configurations/proxy" } ,
164+ { label : "Token" , slug : "configurations/token" } ,
165+ ] ,
166+ } ,
167+ {
168+ label : "Engines" ,
169+ items : [
170+ { label : "Overview" , slug : "engines" } ,
171+ { label : "LlamaCpp" , slug : "engines/llamacpp" } ,
45172 ] ,
46173 } ,
47174 {
48175 label : "Guides" ,
49176 items : [
50- // Each item here is one entry in the navigation menu.
51- { label : "Example Guide" , slug : "guides/example" } ,
177+ { label : "Function Calling" , slug : "guides/function-calling" } ,
178+ { label : "Structured Outputs" , slug : "guides/structured-outputs" } ,
179+ ] ,
180+ } ,
181+ {
182+ label : "Architecture" ,
183+ items : [
184+ { label : "Overview" , slug : "architecture" } ,
185+ { label : "Cortex DB" , slug : "architecture/cortex-db" } ,
186+ { label : "Cortex RC" , slug : "architecture/cortexrc" } ,
187+ { label : "Data Folder" , slug : "architecture/data-folder" } ,
188+ { label : "Updater" , slug : "architecture/updater" } ,
189+ { label : "Benchmarking" , slug : "benchmarking-architecture" } ,
190+ { label : "Telemetry" , slug : "telemetry-architecture" } ,
52191 ] ,
53192 } ,
54193 {
55- label : "Reference" ,
56- autogenerate : { directory : "reference" } ,
194+ label : "Cortex Platform" ,
195+ items : [
196+ { label : "About" , slug : "cortex-platform/about" } ,
197+ { label : "Benchmarking" , slug : "cortex-platform/benchmarking" } ,
198+ ] ,
57199 } ,
58200 ] ,
201+ plugins : [
202+ starlightUtils ( {
203+ navLinks : {
204+ leading : { useSidebarLabelled : "Title Bar" } ,
205+ } ,
206+ } ) ,
207+ ] ,
59208 } ) ,
60209 ] ,
61210} ) ;
0 commit comments