Navbar links to /api-reference

docs/docs/intro/how-jan-works.md

@@ -3,9 +3,9 @@ title: How Jan Works
 ---
 
 - Local Filesystem
-Follow-on from Quickstart to show how things actually worked
+  - Follow-on from Quickstart to show how things actually worked
-Write in a conversational style, show how things work under the hood
+  - Write in a conversational style, show how things work under the hood
-Check how filesystem changed after each request
+  - Check how filesystem changed after each request
 - Model loading into RAM/VRAM
-Explain how the .bin file is loaded via Llama.cpp
+  - Explain how the .bin file is loaded via Llama.cpp
-Explain how it consumes RAM and VRAM, and refer to system monitor
+  - Explain how it consumes RAM and VRAM, and refer to system monitor

docs/docs/intro/quickstart.md

@@ -1,3 +1,7 @@
 ---
 title: Quickstart
 ---
+
+- Write in the style of comics, explanation
+- Similar to why's (poignant) Guide to Ruby
+- https://en.wikipedia.org/wiki/Why%27s_(poignant)_Guide_to_Ruby

docs/docusaurus.config.js

@@ -103,12 +103,8 @@ const config = {
       {
         specs: [
           {
-            spec: "openapi/OpenAPISpec.json",
+            spec: "openapi/jan.yaml", // can be local file, url, or parsed json object
-            route: "/api"
+            route: "/api-reference", // path where to render docs
-          },
-          {
-            spec: "openapi/OpenAIAPI.yaml", // can be local file, url, or parsed json object
-            route: "/api/openai",
           },
         ],
         theme: {
@@ -148,9 +144,8 @@ const config = {
           label: "Documentation",
         },
         {
-          type: "docSidebar",
-          sidebarId: "apiSidebar",
           position: "left",
+          to: "/api-reference",
           label: "API Reference",
         },
         // Navbar right

docs/openapi/OpenAPISpec.json

@@ -1,74 +0,0 @@
-{
-    "openapi": "3.0.0",
-    "info": {
-      "description": "Jan.ai api reference documentation.",
-      "title": "Rest Endpoints",
-      "version": ""
-    },
-    "paths": {
-      "/api/rest/myquery": {
-        "get": {
-          "summary": "MyQuery",
-          "description": "***\nThe GraphQl query for this endpoint is:\n``` graphql\nquery MyQuery {\n  collections {\n    id\n    name\n    slug\n  }\n}\n```",
-          "parameters": [
-            {
-              "description": "Your x-hasura-admin-secret will be used for authentication of the API request.",
-              "in": "header",
-              "name": "x-hasura-admin-secret",
-              "schema": {
-                "type": "string"
-              }
-            }
-          ],
-          "responses": {
-            "200": {
-              "content": {
-                "application/json": {
-                  "schema": {
-                    "properties": {
-                      "collections": {
-                        "items": {
-                          "description": "columns and relationships of \"collections\"",
-                          "nullable": false,
-                          "properties": {
-                            "id": {
-                              "$ref": "#/components/schemas/uuid!"
-                            },
-                            "name": {
-                              "nullable": false,
-                              "title": "String",
-                              "type": "string"
-                            },
-                            "slug": {
-                              "nullable": false,
-                              "title": "String",
-                              "type": "string"
-                            }
-                          },
-                          "title": "collections",
-                          "type": "object"
-                        },
-                        "nullable": false,
-                        "type": "array"
-                      }
-                    }
-                  }
-                }
-              },
-              "description": "Responses for GET /api/rest/myquery"
-            }
-          }
-        }
-      }
-    },
-    "components": {
-      "schemas": {
-        "uuid!": {
-          "nullable": false,
-          "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}",
-          "title": "uuid",
-          "type": "string"
-        }
-      }
-    }
-  }