diff --git a/docs/docs/docs/01-overview.md b/docs/docs/docs/01-overview.md new file mode 100644 index 0000000000..03d5592e1c --- /dev/null +++ b/docs/docs/docs/01-overview.md @@ -0,0 +1,20 @@ +--- +title: Overview +slug: /docs +description: Jan Docs | Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/01-build-extension.md b/docs/docs/docs/02-get-started/01-build-extension.md new file mode 100644 index 0000000000..e84f25604c --- /dev/null +++ b/docs/docs/docs/02-get-started/01-build-extension.md @@ -0,0 +1,7 @@ +--- +title: Build an Extension +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/02-extension-anatomy.md b/docs/docs/docs/02-get-started/02-extension-anatomy.md new file mode 100644 index 0000000000..c4a372004a --- /dev/null +++ b/docs/docs/docs/02-get-started/02-extension-anatomy.md @@ -0,0 +1,9 @@ +--- +title: Anatomy of an Extension +--- + +:::caution +This is currently under development. +::: + +Anatomy and lifecycle diff --git a/docs/docs/docs/02-get-started/03-use-local-server.md b/docs/docs/docs/02-get-started/03-use-local-server.md new file mode 100644 index 0000000000..e6b3f46278 --- /dev/null +++ b/docs/docs/docs/02-get-started/03-use-local-server.md @@ -0,0 +1,7 @@ +--- +title: Using the Local Server +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/04-build-on-desktop.md b/docs/docs/docs/02-get-started/04-build-on-desktop.md new file mode 100644 index 0000000000..e652953a02 --- /dev/null +++ b/docs/docs/docs/02-get-started/04-build-on-desktop.md @@ -0,0 +1,7 @@ +--- +title: Building for Desktop +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/05-build-on-mobile.md b/docs/docs/docs/02-get-started/05-build-on-mobile.md new file mode 100644 index 0000000000..9a12f44a44 --- /dev/null +++ b/docs/docs/docs/02-get-started/05-build-on-mobile.md @@ -0,0 +1,7 @@ +--- +title: Building for Mobile +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/02-get-started/README.md b/docs/docs/docs/02-get-started/README.md new file mode 100644 index 0000000000..3c8409423b --- /dev/null +++ b/docs/docs/docs/02-get-started/README.md @@ -0,0 +1,12 @@ +--- +title: Get Started +--- + +:::caution +This is currently under development. +::: +There are various ways to build on top of Jan. + +1. Use Jan as a local AI server +2. Build a cross-platform extension for Desktop application +3. ... diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md new file mode 100644 index 0000000000..09a6dc26d9 --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/01-Core.md @@ -0,0 +1,7 @@ +--- +title: Core +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/03-extension-capabilities/02-common-extensions.md b/docs/docs/docs/03-extension-capabilities/02-common-extensions.md new file mode 100644 index 0000000000..68aa0f12aa --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/02-common-extensions.md @@ -0,0 +1,7 @@ +--- +title: Common Extensions +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/03-extension-capabilities/README.md b/docs/docs/docs/03-extension-capabilities/README.md new file mode 100644 index 0000000000..2a52325b18 --- /dev/null +++ b/docs/docs/docs/03-extension-capabilities/README.md @@ -0,0 +1,9 @@ +--- +title: Extension Capabilities +--- + +# Overview + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/README.md b/docs/docs/docs/04-extension-guides/README.md new file mode 100644 index 0000000000..1ef5a69673 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/README.md @@ -0,0 +1,7 @@ +--- +title: Extension Guides +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/assistant.md b/docs/docs/docs/04-extension-guides/assistant.md new file mode 100644 index 0000000000..dd907837ef --- /dev/null +++ b/docs/docs/docs/04-extension-guides/assistant.md @@ -0,0 +1,7 @@ +--- +title: Assitant +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/inference.md b/docs/docs/docs/04-extension-guides/inference.md new file mode 100644 index 0000000000..d333f02f35 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/inference.md @@ -0,0 +1,7 @@ +--- +title: Inference +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/model.md b/docs/docs/docs/04-extension-guides/model.md new file mode 100644 index 0000000000..77f27c94da --- /dev/null +++ b/docs/docs/docs/04-extension-guides/model.md @@ -0,0 +1,7 @@ +--- +title: Model +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/monitoring.md b/docs/docs/docs/04-extension-guides/monitoring.md new file mode 100644 index 0000000000..1f6d6af469 --- /dev/null +++ b/docs/docs/docs/04-extension-guides/monitoring.md @@ -0,0 +1,7 @@ +--- +title: Monitoring +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/04-extension-guides/threads-messages.md b/docs/docs/docs/04-extension-guides/threads-messages.md new file mode 100644 index 0000000000..b56f8d98ae --- /dev/null +++ b/docs/docs/docs/04-extension-guides/threads-messages.md @@ -0,0 +1,7 @@ +--- +title: Thread & Messages +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/05-UI/README.md b/docs/docs/docs/05-UI/README.md new file mode 100644 index 0000000000..16e35b0259 --- /dev/null +++ b/docs/docs/docs/05-UI/README.md @@ -0,0 +1,7 @@ +--- +title: UI +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/docs/assistants.md b/docs/docs/docs/assistants.md deleted file mode 100644 index 612229af34..0000000000 --- a/docs/docs/docs/assistants.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build an Assistant -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/extensions.md b/docs/docs/docs/extensions.md deleted file mode 100644 index 11128ec41a..0000000000 --- a/docs/docs/docs/extensions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Extending Jan -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- - -## Overview - -- Jan exports a developer SDK which lets you customize assistants, Jan app, and more. -- Jan exports a AI-friendly UI kit which lets people customize the [Jan UI](/specs/user-interface). -- Jan provisions a local AI server which lets you built external applications on other platforms. diff --git a/docs/docs/docs/modules.md b/docs/docs/docs/modules.md deleted file mode 100644 index 3cec1aa3b5..0000000000 --- a/docs/docs/docs/modules.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Module -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/themes.md b/docs/docs/docs/themes.md deleted file mode 100644 index 8760d3ca64..0000000000 --- a/docs/docs/docs/themes.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Theme -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/docs/tools.md b/docs/docs/docs/tools.md deleted file mode 100644 index e7a0cb85de..0000000000 --- a/docs/docs/docs/tools.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Build a Tool -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- \ No newline at end of file diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/guides/how-jan-works.md similarity index 100% rename from docs/docs/intro/how-jan-works.md rename to docs/docs/guides/how-jan-works.md diff --git a/docs/docs/intro/introduction.md b/docs/docs/guides/introduction.md similarity index 99% rename from docs/docs/intro/introduction.md rename to docs/docs/guides/introduction.md index 632aeeee4d..bc40a07655 100644 --- a/docs/docs/intro/introduction.md +++ b/docs/docs/guides/introduction.md @@ -1,6 +1,6 @@ --- title: Introduction -slug: /docs +slug: /guides description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. keywords: [ diff --git a/docs/docs/docs/models.md b/docs/docs/guides/models.md similarity index 100% rename from docs/docs/docs/models.md rename to docs/docs/guides/models.md diff --git a/docs/docs/intro/quickstart.md b/docs/docs/guides/quickstart.md similarity index 100% rename from docs/docs/intro/quickstart.md rename to docs/docs/guides/quickstart.md diff --git a/docs/docs/docs/server.md b/docs/docs/guides/server.md similarity index 100% rename from docs/docs/docs/server.md rename to docs/docs/guides/server.md diff --git a/docs/sidebars.js b/docs/sidebars.js index 384f47e9dd..51db7fcb88 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -17,10 +17,10 @@ const sidebars = { { type: "category", label: "Introduction", - link: { type: "doc", id: "intro/introduction" }, + link: { type: "doc", id: "guides/introduction" }, collapsible: true, collapsed: true, - items: ["intro/quickstart", "intro/how-jan-works"], + items: ["guides/quickstart", "guides/how-jan-works"], }, { type: "category", @@ -40,16 +40,15 @@ const sidebars = { label: "Using Jan", collapsible: true, collapsed: true, - items: ["docs/models", "docs/server"], + items: ["guides/models", "guides/server"], }, ], developerSidebar: [ - "docs/extensions", - "docs/assistants", - "docs/themes", - "docs/tools", - "docs/modules", + { + type: "autogenerated", + dirName: "docs", + }, ], specsSidebar: [