From 1cea34974830334087bf44392d270e9e572ccda0 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Thu, 4 Jan 2024 13:51:14 +0700 Subject: [PATCH 1/2] docs: configure index page --- .../01-your-first-assistant.md | 16 +++++++++++- .../02-assistant-anatomy.md | 17 +++++++++++-- .../03-package-your-assistant.md | 17 +++++++++++-- .../developer/02-build-assistant/README.md | 12 --------- .../developer/02-build-assistant/README.mdx | 25 +++++++++++++++++++ .../03-build-engine/01-your-first-engine.md | 19 ++++++++++++-- .../03-build-engine/02-engine-anatomy.md | 17 +++++++++++-- .../03-build-engine/03-package-your-engine.md | 19 +++++++++++--- docs/docs/developer/03-build-engine/README.md | 12 --------- .../docs/developer/03-build-engine/README.mdx | 25 +++++++++++++++++++ .../01-your-first-extension.md | 17 +++++++++++-- .../02-extension-anatomy.md | 17 +++++++++++-- .../03-package-your-assistant.md | 9 ------- .../03-package-your-extension.md | 22 ++++++++++++++++ .../developer/04-build-extension/README.md | 9 ------- .../developer/04-build-extension/README.mdx | 25 +++++++++++++++++++ docs/docs/docs/engineering/README.md | 5 ---- docs/docs/docs/engineering/README.mdx | 24 ++++++++++++++++++ docs/docs/docs/product/README.md | 3 --- docs/docs/docs/product/README.mdx | 22 ++++++++++++++++ docs/docs/guides/03-chatting/README.md | 3 --- docs/docs/guides/03-chatting/README.mdx | 23 +++++++++++++++++ .../04-using-models/01-install-from-hub.mdx | 2 +- .../04-using-models/02-import-manually.mdx | 2 +- .../03-integrate-with-remote-server.mdx | 2 +- docs/docs/guides/04-using-models/README.md | 3 --- docs/docs/guides/04-using-models/README.mdx | 21 ++++++++++++++++ docs/docs/guides/05-using-server/01-server.md | 2 +- docs/docs/guides/05-using-server/README.md | 3 --- docs/docs/guides/05-using-server/README.mdx | 21 ++++++++++++++++ .../01-import-extensions.md | 16 +++++++++++- .../02-extension-settings.md | 18 ++++++++++--- .../docs/guides/06-using-extensions/README.md | 3 --- .../guides/06-using-extensions/README.mdx | 21 ++++++++++++++++ .../01-stuck-on-broken-build.mdx | 2 +- docs/docs/guides/07-troubleshooting/README.md | 3 --- .../docs/guides/07-troubleshooting/README.mdx | 21 ++++++++++++++++ docs/src/css/custom.css | 3 +++ docs/src/css/custom_toc.css | 9 +++++++ docs/src/styles/main.scss | 2 ++ docs/src/styles/tweaks/markdown.scss | 2 +- 41 files changed, 423 insertions(+), 91 deletions(-) delete mode 100644 docs/docs/developer/02-build-assistant/README.md create mode 100644 docs/docs/developer/02-build-assistant/README.mdx delete mode 100644 docs/docs/developer/03-build-engine/README.md create mode 100644 docs/docs/developer/03-build-engine/README.mdx delete mode 100644 docs/docs/developer/04-build-extension/03-package-your-assistant.md create mode 100644 docs/docs/developer/04-build-extension/03-package-your-extension.md delete mode 100644 docs/docs/developer/04-build-extension/README.md create mode 100644 docs/docs/developer/04-build-extension/README.mdx delete mode 100644 docs/docs/docs/engineering/README.md create mode 100644 docs/docs/docs/engineering/README.mdx delete mode 100644 docs/docs/docs/product/README.md create mode 100644 docs/docs/docs/product/README.mdx delete mode 100644 docs/docs/guides/03-chatting/README.md create mode 100644 docs/docs/guides/03-chatting/README.mdx delete mode 100644 docs/docs/guides/04-using-models/README.md create mode 100644 docs/docs/guides/04-using-models/README.mdx delete mode 100644 docs/docs/guides/05-using-server/README.md create mode 100644 docs/docs/guides/05-using-server/README.mdx delete mode 100644 docs/docs/guides/06-using-extensions/README.md create mode 100644 docs/docs/guides/06-using-extensions/README.mdx delete mode 100644 docs/docs/guides/07-troubleshooting/README.md create mode 100644 docs/docs/guides/07-troubleshooting/README.mdx create mode 100644 docs/src/css/custom.css diff --git a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md index 11999981f..16b80fc5e 100644 --- a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md +++ b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md @@ -1,9 +1,23 @@ --- title: Your First Assistant +slug: /developer/build-assistant/your-first-assistant/ +description: A quick start on how to build an assistant. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + quick start, + build assistant, + ] --- :::caution This is currently under development. ::: -A quickstart on how to build an assistant diff --git a/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md b/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md index 6c5fc1035..e6951a05b 100644 --- a/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md +++ b/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md @@ -1,9 +1,22 @@ --- title: Anatomy of an Assistant +slug: /developer/build-assistant/assistant-anatomy/ +description: An overview of assistant.json +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + build assistant, + assistant anatomy, + ] --- :::caution This is currently under development. ::: - -An overview of assistant.json diff --git a/docs/docs/developer/02-build-assistant/03-package-your-assistant.md b/docs/docs/developer/02-build-assistant/03-package-your-assistant.md index 8d384cb8a..12fa1510c 100644 --- a/docs/docs/developer/02-build-assistant/03-package-your-assistant.md +++ b/docs/docs/developer/02-build-assistant/03-package-your-assistant.md @@ -1,9 +1,22 @@ --- title: Package your Assistant +slug: /developer/build-assistant/package-your-assistant/ +description: Package your assistant for sharing and publishing. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + quick start, + build assistant, + ] --- :::caution This is currently under development. ::: - -Packaging, exporting, sharing, publishing an assistant to Hub diff --git a/docs/docs/developer/02-build-assistant/README.md b/docs/docs/developer/02-build-assistant/README.md deleted file mode 100644 index 28264ae9c..000000000 --- a/docs/docs/developer/02-build-assistant/README.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Build an Assistant ---- - -:::caution -This is currently under development. -::: - -In this tutorial you will learn: - -- -- diff --git a/docs/docs/developer/02-build-assistant/README.mdx b/docs/docs/developer/02-build-assistant/README.mdx new file mode 100644 index 000000000..29cf8b63d --- /dev/null +++ b/docs/docs/developer/02-build-assistant/README.mdx @@ -0,0 +1,25 @@ +--- +title: Build an Assistant +slug: /developer/build-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, + build assistant, + ] +--- + +:::caution +This is currently under development. +::: + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/developer/03-build-engine/01-your-first-engine.md b/docs/docs/developer/03-build-engine/01-your-first-engine.md index 8323354f8..0670d63c4 100644 --- a/docs/docs/developer/03-build-engine/01-your-first-engine.md +++ b/docs/docs/developer/03-build-engine/01-your-first-engine.md @@ -1,9 +1,24 @@ --- -title: Your First Assistant +title: Your First Engine +slug: /developer/build-engine/your-first-engine/ +description: A quick start on how to build your first engine +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + quick start, + build engine, + ] --- :::caution This is currently under development. ::: -A quickstart on how to integrate tensorrt llm +A quickstart on how to integrate tensorrt llm \ No newline at end of file diff --git a/docs/docs/developer/03-build-engine/02-engine-anatomy.md b/docs/docs/developer/03-build-engine/02-engine-anatomy.md index 45c657141..1e7f559da 100644 --- a/docs/docs/developer/03-build-engine/02-engine-anatomy.md +++ b/docs/docs/developer/03-build-engine/02-engine-anatomy.md @@ -1,9 +1,22 @@ --- title: Anatomy of an Engine +slug: /developer/build-engine/engine-anatomy +description: An overview of engine.json +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + build engine, + engine anatomy, + ] --- :::caution This is currently under development. ::: - -An overview of engine.json diff --git a/docs/docs/developer/03-build-engine/03-package-your-engine.md b/docs/docs/developer/03-build-engine/03-package-your-engine.md index d6acfd6fd..794e1abb2 100644 --- a/docs/docs/developer/03-build-engine/03-package-your-engine.md +++ b/docs/docs/developer/03-build-engine/03-package-your-engine.md @@ -1,9 +1,22 @@ --- -title: Package your Extension +title: Package your Engine +slug: /developer/build-engine/package-your-engine/ +description: Package your engine for sharing and publishing. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + build engine, + engine anatomy, + ] --- :::caution This is currently under development. ::: - -Packaging, exporting, sharing, publishing an engine config to Hub diff --git a/docs/docs/developer/03-build-engine/README.md b/docs/docs/developer/03-build-engine/README.md deleted file mode 100644 index fa9f486fe..000000000 --- a/docs/docs/developer/03-build-engine/README.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Build an Inference Engine ---- - -:::caution -This is currently under development. -::: - -In this tutorial you will learn: - -- -- diff --git a/docs/docs/developer/03-build-engine/README.mdx b/docs/docs/developer/03-build-engine/README.mdx new file mode 100644 index 000000000..a2521ff54 --- /dev/null +++ b/docs/docs/developer/03-build-engine/README.mdx @@ -0,0 +1,25 @@ +--- +title: Build an Inference Engine +slug: /developer/build-engine/ +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, + build assistant, + ] +--- + +:::caution +This is currently under development. +::: + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/developer/04-build-extension/01-your-first-extension.md b/docs/docs/developer/04-build-extension/01-your-first-extension.md index 0e5241e3c..6ffe2de2f 100644 --- a/docs/docs/developer/04-build-extension/01-your-first-extension.md +++ b/docs/docs/developer/04-build-extension/01-your-first-extension.md @@ -1,9 +1,22 @@ --- title: Your First Extension +slug: /developer/build-extension/your-first-extension/ +description: A quick start on how to build your first extension +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + quick start, + build extension, + ] --- :::caution This is currently under development. ::: - -A quickstart on tensorrt-llm impl diff --git a/docs/docs/developer/04-build-extension/02-extension-anatomy.md b/docs/docs/developer/04-build-extension/02-extension-anatomy.md index 55b3def4b..7c3cd1911 100644 --- a/docs/docs/developer/04-build-extension/02-extension-anatomy.md +++ b/docs/docs/developer/04-build-extension/02-extension-anatomy.md @@ -1,9 +1,22 @@ --- title: Anatomy of an Extension +slug: /developer/build-extension/extension-anatomy +description: An overview of extensions.json +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + build extension, + extension anatomy, + ] --- :::caution This is currently under development. ::: - -An overview of engine.json diff --git a/docs/docs/developer/04-build-extension/03-package-your-assistant.md b/docs/docs/developer/04-build-extension/03-package-your-assistant.md deleted file mode 100644 index c32a24a67..000000000 --- a/docs/docs/developer/04-build-extension/03-package-your-assistant.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Package your Extension ---- - -:::caution -This is currently under development. -::: - -Packaging, exporting, sharing, publishing an extension to Hub diff --git a/docs/docs/developer/04-build-extension/03-package-your-extension.md b/docs/docs/developer/04-build-extension/03-package-your-extension.md new file mode 100644 index 000000000..cf7ffc6ba --- /dev/null +++ b/docs/docs/developer/04-build-extension/03-package-your-extension.md @@ -0,0 +1,22 @@ +--- +title: Package your Engine +slug: /developer/build-extension/package-your-extension/ +description: Package your extension for sharing and publishing. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + build extension, + extension anatomy, + ] +--- + +:::caution +This is currently under development. +::: diff --git a/docs/docs/developer/04-build-extension/README.md b/docs/docs/developer/04-build-extension/README.md deleted file mode 100644 index fb759164a..000000000 --- a/docs/docs/developer/04-build-extension/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Build an Extension ---- - -# Overview - -:::caution -This is currently under development. -::: diff --git a/docs/docs/developer/04-build-extension/README.mdx b/docs/docs/developer/04-build-extension/README.mdx new file mode 100644 index 000000000..a981281e7 --- /dev/null +++ b/docs/docs/developer/04-build-extension/README.mdx @@ -0,0 +1,25 @@ +--- +title: Build an Extension +slug: /developer/build-extension/ +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, + build extension, + ] +--- + +:::caution +This is currently under development. +::: + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/docs/engineering/README.md b/docs/docs/docs/engineering/README.md deleted file mode 100644 index 3c87ba845..000000000 --- a/docs/docs/docs/engineering/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Engineering Specs ---- - -Talk about CoreSDK here diff --git a/docs/docs/docs/engineering/README.mdx b/docs/docs/docs/engineering/README.mdx new file mode 100644 index 000000000..2fd9a5cc1 --- /dev/null +++ b/docs/docs/docs/engineering/README.mdx @@ -0,0 +1,24 @@ +--- +title: Engineering Specs +slug: /docs/engineering +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, + spec, + engineering, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + + +Talk about CoreSDK here diff --git a/docs/docs/docs/product/README.md b/docs/docs/docs/product/README.md deleted file mode 100644 index 5a00a0cf2..000000000 --- a/docs/docs/docs/product/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Product Specs ---- diff --git a/docs/docs/docs/product/README.mdx b/docs/docs/docs/product/README.mdx new file mode 100644 index 000000000..cce274f22 --- /dev/null +++ b/docs/docs/docs/product/README.mdx @@ -0,0 +1,22 @@ +--- +title: Product Specs +slug: /docs/product +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, + spec, + product, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/03-chatting/README.md b/docs/docs/guides/03-chatting/README.md deleted file mode 100644 index 731d3a2b6..000000000 --- a/docs/docs/guides/03-chatting/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Chatting ---- diff --git a/docs/docs/guides/03-chatting/README.mdx b/docs/docs/guides/03-chatting/README.mdx new file mode 100644 index 000000000..6b5550964 --- /dev/null +++ b/docs/docs/guides/03-chatting/README.mdx @@ -0,0 +1,23 @@ +--- +title: Chatting +slug: /guides/chatting/ +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, + chatting, + ] +--- + +This guide is designed to help you maximize your experience with Jan, covering everything from starting engaging threads to managing your chat history effectively. + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/04-using-models/01-install-from-hub.mdx b/docs/docs/guides/04-using-models/01-install-from-hub.mdx index 414e57fa1..1f1b97b0c 100644 --- a/docs/docs/guides/04-using-models/01-install-from-hub.mdx +++ b/docs/docs/guides/04-using-models/01-install-from-hub.mdx @@ -1,6 +1,6 @@ --- title: Install Models from the Hub -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Guide to install models from the Hub. keywords: [ Jan AI, diff --git a/docs/docs/guides/04-using-models/02-import-manually.mdx b/docs/docs/guides/04-using-models/02-import-manually.mdx index 97cc53d77..b2a7158bf 100644 --- a/docs/docs/guides/04-using-models/02-import-manually.mdx +++ b/docs/docs/guides/04-using-models/02-import-manually.mdx @@ -1,7 +1,7 @@ --- title: Import Models Manually slug: /guides/using-models/import-manually -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Guide to manually import a local model into Jan. keywords: [ Jan AI, diff --git a/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx b/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx index 05327d477..660b4b044 100644 --- a/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx +++ b/docs/docs/guides/04-using-models/03-integrate-with-remote-server.mdx @@ -1,7 +1,7 @@ --- title: Integrate With a Remote Server slug: /guides/using-models/integrate-with-remote-server -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Guide to integrate with a remote server. keywords: [ Jan AI, diff --git a/docs/docs/guides/04-using-models/README.md b/docs/docs/guides/04-using-models/README.md deleted file mode 100644 index ad958633d..000000000 --- a/docs/docs/guides/04-using-models/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Using Models ---- diff --git a/docs/docs/guides/04-using-models/README.mdx b/docs/docs/guides/04-using-models/README.mdx new file mode 100644 index 000000000..3c1ee7778 --- /dev/null +++ b/docs/docs/guides/04-using-models/README.mdx @@ -0,0 +1,21 @@ +--- +title: Using Models +slug: /guides/using-models/ +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, + using-models, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/05-using-server/01-server.md b/docs/docs/guides/05-using-server/01-server.md index aa5bf8d3a..685a7b4a6 100644 --- a/docs/docs/guides/05-using-server/01-server.md +++ b/docs/docs/guides/05-using-server/01-server.md @@ -1,6 +1,6 @@ --- title: Connect to Server -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Connect to Jan's built-in API server. keywords: [ Jan AI, diff --git a/docs/docs/guides/05-using-server/README.md b/docs/docs/guides/05-using-server/README.md deleted file mode 100644 index 500f2bb27..000000000 --- a/docs/docs/guides/05-using-server/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Using the Local Server ---- diff --git a/docs/docs/guides/05-using-server/README.mdx b/docs/docs/guides/05-using-server/README.mdx new file mode 100644 index 000000000..79ccad1f6 --- /dev/null +++ b/docs/docs/guides/05-using-server/README.mdx @@ -0,0 +1,21 @@ +--- +title: Using the Local Server +slug: /guides/using-server/ +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, + using-server, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/06-using-extensions/01-import-extensions.md b/docs/docs/guides/06-using-extensions/01-import-extensions.md index 69cc14cc1..52e26c7d0 100644 --- a/docs/docs/guides/06-using-extensions/01-import-extensions.md +++ b/docs/docs/guides/06-using-extensions/01-import-extensions.md @@ -1,3 +1,17 @@ --- title: Import Extensions ---- +slug: /guides/using-extensions/import-extensions/ +description: Import extensions into Jan. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + using-models, + ] +--- \ No newline at end of file diff --git a/docs/docs/guides/06-using-extensions/02-extension-settings.md b/docs/docs/guides/06-using-extensions/02-extension-settings.md index 6892a4c93..d5b053b72 100644 --- a/docs/docs/guides/06-using-extensions/02-extension-settings.md +++ b/docs/docs/guides/06-using-extensions/02-extension-settings.md @@ -1,5 +1,17 @@ --- title: Extension Settings ---- - -TODO: how to configure settings for extensions +slug: /guides/using-extensions/extension-settings/ +description: Configure settings for extensions. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + using-models, + ] +--- \ No newline at end of file diff --git a/docs/docs/guides/06-using-extensions/README.md b/docs/docs/guides/06-using-extensions/README.md deleted file mode 100644 index c2221099f..000000000 --- a/docs/docs/guides/06-using-extensions/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Using Extensions ---- diff --git a/docs/docs/guides/06-using-extensions/README.mdx b/docs/docs/guides/06-using-extensions/README.mdx new file mode 100644 index 000000000..015fc5948 --- /dev/null +++ b/docs/docs/guides/06-using-extensions/README.mdx @@ -0,0 +1,21 @@ +--- +title: Using Extensions +slug: /guides/using-extensions/ +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, + using-extensions, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx index 527588092..5a138adb6 100644 --- a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx +++ b/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx @@ -1,7 +1,7 @@ --- title: Stuck on a Broken Build slug: /troubleshooting/stuck-on-broken-build -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Troubleshooting steps to resolve issues related to broken builds. keywords: [ Jan AI, diff --git a/docs/docs/guides/07-troubleshooting/README.md b/docs/docs/guides/07-troubleshooting/README.md deleted file mode 100644 index 9662ac078..000000000 --- a/docs/docs/guides/07-troubleshooting/README.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Troubleshooting ---- diff --git a/docs/docs/guides/07-troubleshooting/README.mdx b/docs/docs/guides/07-troubleshooting/README.mdx new file mode 100644 index 000000000..2b8a3b89f --- /dev/null +++ b/docs/docs/guides/07-troubleshooting/README.mdx @@ -0,0 +1,21 @@ +--- +title: Troubleshooting +slug: /guides/troubleshooting/ +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, + troubleshooting, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css new file mode 100644 index 000000000..115bc3f21 --- /dev/null +++ b/docs/src/css/custom.css @@ -0,0 +1,3 @@ +.DocCardList--no-description .card p { + display: none; +} \ No newline at end of file diff --git a/docs/src/css/custom_toc.css b/docs/src/css/custom_toc.css index 68abfb866..4f8eb6655 100644 --- a/docs/src/css/custom_toc.css +++ b/docs/src/css/custom_toc.css @@ -3,3 +3,12 @@ margin-bottom: 16px; margin-top: -20px; } +.DocCardList--no-description .card h2 { + margin-bottom: 0; + text-decoration: none; + +} + +.DocCardList--no-description .card p { + display: none; +} \ No newline at end of file diff --git a/docs/src/styles/main.scss b/docs/src/styles/main.scss index 216b960d3..4c6fc7151 100644 --- a/docs/src/styles/main.scss +++ b/docs/src/styles/main.scss @@ -11,3 +11,5 @@ @import "./tweaks/markdown.scss"; @import "./tweaks/redocusaurus.scss"; @import "./tweaks/sidebar.scss"; + +@import "../css/custom.css"; \ No newline at end of file diff --git a/docs/src/styles/tweaks/markdown.scss b/docs/src/styles/tweaks/markdown.scss index 7e8e33871..1093f2318 100644 --- a/docs/src/styles/tweaks/markdown.scss +++ b/docs/src/styles/tweaks/markdown.scss @@ -1,6 +1,6 @@ .theme-doc-markdown { a { - @apply text-blue-600 dark:text-blue-400 underline; + @apply text-blue-600 dark:text-blue-400; } ul { list-style: revert; From c51edd12acdbaaf19627fc317919664779f53780 Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Thu, 4 Jan 2024 14:06:26 +0700 Subject: [PATCH 2/2] docs: remove unnec change --- docs/src/css/custom_toc.css | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/src/css/custom_toc.css b/docs/src/css/custom_toc.css index 4f8eb6655..2410f7a06 100644 --- a/docs/src/css/custom_toc.css +++ b/docs/src/css/custom_toc.css @@ -2,13 +2,4 @@ font-weight: bold; margin-bottom: 16px; margin-top: -20px; -} -.DocCardList--no-description .card h2 { - margin-bottom: 0; - text-decoration: none; - -} - -.DocCardList--no-description .card p { - display: none; } \ No newline at end of file