diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/intro/how-jan-works.md index 54122356d..fdfd12a10 100644 --- a/docs/docs/intro/how-jan-works.md +++ b/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 -Write in a conversational style, show how things work under the hood -Check how filesystem changed after each request + - Follow-on from Quickstart to show how things actually worked + - Write in a conversational style, show how things work under the hood + - Check how filesystem changed after each request - Model loading into RAM/VRAM -Explain how the .bin file is loaded via Llama.cpp -Explain how it consumes RAM and VRAM, and refer to system monitor + - Explain how the .bin file is loaded via Llama.cpp + - Explain how it consumes RAM and VRAM, and refer to system monitor diff --git a/docs/docs/intro/quickstart.md b/docs/docs/intro/quickstart.md index 18f6fc0aa..e417838ea 100644 --- a/docs/docs/intro/quickstart.md +++ b/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 \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index e5fd117ad..09757c67a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -103,12 +103,8 @@ const config = { { specs: [ { - spec: "openapi/OpenAPISpec.json", - route: "/api" - }, - { - spec: "openapi/OpenAIAPI.yaml", // can be local file, url, or parsed json object - route: "/api/openai", + spec: "openapi/jan.yaml", // can be local file, url, or parsed json object + route: "/api-reference", // path where to render docs }, ], theme: { @@ -148,9 +144,8 @@ const config = { label: "Documentation", }, { - type: "docSidebar", - sidebarId: "apiSidebar", position: "left", + to: "/api-reference", label: "API Reference", }, // Navbar right diff --git a/docs/openapi/OpenAPISpec.json b/docs/openapi/OpenAPISpec.json deleted file mode 100644 index c8b20eb65..000000000 --- a/docs/openapi/OpenAPISpec.json +++ /dev/null @@ -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" - } - } - } - } \ No newline at end of file diff --git a/docs/openapi/OpenAIAPI.yaml b/docs/openapi/jan.yaml similarity index 100% rename from docs/openapi/OpenAIAPI.yaml rename to docs/openapi/jan.yaml