diff --git a/website/docs/clients/extensions/installation/index.mdx b/website/docs/clients/extensions/installation/index.mdx deleted file mode 100644 index f9c7ebcf03b9..000000000000 --- a/website/docs/clients/extensions/installation/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# πŸ“¦ Installation - -import DocCardList from '@theme/DocCardList'; - - diff --git a/website/docs/clients/index.mdx b/website/docs/clients/index.mdx deleted file mode 100644 index a0890e3c02dd..000000000000 --- a/website/docs/clients/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 2 ---- - -import DocCardList from '@theme/DocCardList'; - -# ⌨️ Coding Assistant - - diff --git a/website/docs/configuration.md b/website/docs/configuration.md index 3d079b782f91..9c8116b0c504 100644 --- a/website/docs/configuration.md +++ b/website/docs/configuration.md @@ -2,7 +2,7 @@ sidebar_position: 5 --- -# βš™οΈ Repository Configuration +# βš™οΈ Configuration Tabby server will look for a configuration file at `~/.tabby/config.toml` for advanced features. diff --git a/website/docs/clients/extensions/configurations.md b/website/docs/extensions/configurations.md similarity index 98% rename from website/docs/clients/extensions/configurations.md rename to website/docs/extensions/configurations.md index 1a019b40636a..8f4a12283a59 100644 --- a/website/docs/clients/extensions/configurations.md +++ b/website/docs/extensions/configurations.md @@ -2,7 +2,7 @@ sidebar_position: 98 --- -# πŸ› οΈ Advanced Configuration +# Advanced Configuration This document describes the available configurations for Tabby IDE extensions. diff --git a/website/docs/clients/extensions/index.mdx b/website/docs/extensions/index.mdx similarity index 75% rename from website/docs/clients/extensions/index.mdx rename to website/docs/extensions/index.mdx index 56534738f7f6..9c12acfb29bc 100644 --- a/website/docs/clients/extensions/index.mdx +++ b/website/docs/extensions/index.mdx @@ -2,7 +2,7 @@ sidebar_position: 3 --- -# πŸ’» Extensions +# πŸ’» IDE / Editor Extensions import DocCardList from '@theme/DocCardList'; diff --git a/website/docs/installation/models/index.mdx b/website/docs/extensions/installation/index.mdx similarity index 86% rename from website/docs/installation/models/index.mdx rename to website/docs/extensions/installation/index.mdx index 45223ffc0199..369993aae8b8 100644 --- a/website/docs/installation/models/index.mdx +++ b/website/docs/extensions/installation/index.mdx @@ -2,8 +2,8 @@ sidebar_position: 1 --- -import DocCardList from '@theme/DocCardList'; +# Installation -# πŸ“ƒ Models +import DocCardList from '@theme/DocCardList'; diff --git a/website/docs/clients/extensions/installation/intellij.mdx b/website/docs/extensions/installation/intellij.mdx similarity index 67% rename from website/docs/clients/extensions/installation/intellij.mdx rename to website/docs/extensions/installation/intellij.mdx index f29d7df6afef..3a1729593456 100644 --- a/website/docs/clients/extensions/installation/intellij.mdx +++ b/website/docs/extensions/installation/intellij.mdx @@ -4,6 +4,6 @@ title: IntelliJ Platform description: Plugin for IDEA, PyCharm, GoLand, Android Studio, and more --- -import IntelliJ from "../../../../../clients/intellij/README.md"; +import IntelliJ from "../../../../clients/intellij/README.md"; diff --git a/website/docs/clients/extensions/installation/vim.mdx b/website/docs/extensions/installation/vim.mdx similarity index 65% rename from website/docs/clients/extensions/installation/vim.mdx rename to website/docs/extensions/installation/vim.mdx index 0e910ee83298..9fa591ad815f 100644 --- a/website/docs/clients/extensions/installation/vim.mdx +++ b/website/docs/extensions/installation/vim.mdx @@ -4,6 +4,6 @@ description: Support for vim / neovim editors title: VIM / NeoVIM --- -import VIM from "../../../../../clients/vim/README.md"; +import VIM from "../../../../clients/vim/README.md"; diff --git a/website/docs/clients/extensions/installation/vscode.mdx b/website/docs/extensions/installation/vscode.mdx similarity index 64% rename from website/docs/clients/extensions/installation/vscode.mdx rename to website/docs/extensions/installation/vscode.mdx index b642cb57fcfd..ff1f0a5029eb 100644 --- a/website/docs/clients/extensions/installation/vscode.mdx +++ b/website/docs/extensions/installation/vscode.mdx @@ -4,6 +4,6 @@ title: Visual Studio Code description: Extension for Visual Studio Code --- -import VSCode from "../../../../../clients/vscode/README.md"; +import VSCode from "../../../../clients/vscode/README.md"; diff --git a/website/docs/clients/extensions/troubleshooting.md b/website/docs/extensions/troubleshooting.md similarity index 99% rename from website/docs/clients/extensions/troubleshooting.md rename to website/docs/extensions/troubleshooting.md index 2e07f1925fa2..f589c99f873c 100644 --- a/website/docs/clients/extensions/troubleshooting.md +++ b/website/docs/extensions/troubleshooting.md @@ -2,7 +2,7 @@ sidebar_position: 99 --- -# 🚨 Troubleshooting +# Troubleshooting This document aims to assist you in troubleshooting issues with the Tabby extensions for various IDEs such as VSCode, IntelliJ Platform IDEs, and Vim / NeoVim. diff --git a/website/docs/getting-started.mdx b/website/docs/getting-started.mdx index 7f27b470a2ee..8e2a2f6b0148 100644 --- a/website/docs/getting-started.mdx +++ b/website/docs/getting-started.mdx @@ -23,14 +23,14 @@ Tabby is an open-source, self-hosted AI coding assistant. With Tabby, every team ## πŸ“„ About the Docs -| Section | Goal | -| --------------------------------------------------------- | --------------------------------------------------------------------------- | -| [πŸ“š Installation](/docs/installation) | Everything deployment: Docker, Homebrew, Hugging Face Space and many others | -| [πŸ’» IDE / Editor Extensions](/docs/clients/extensions) | IDE/Editor extensions that can be seamlessly integrated with Tabby | -| [πŸ§‘β€πŸ”¬ Models Directory](/docs/installation/models) | A curated list of models that we recommend using with Tabby | -| [🏷️ API References](/api) | API Documentation | -| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing | -| [πŸ—ΊοΈ Roadmap](/docs/roadmap) | Our future plans | +| Section | Goal | +| ------------------------------------------- | --------------------------------------------------------------------------- | +| [πŸ“š Installation](/docs/installation) | Everything deployment: Docker, Homebrew, Hugging Face Space and many others | +| [πŸ’» IDE / Editor Extensions](/docs/extensions) | IDE/Editor extensions that can be seamlessly integrated with Tabby | +| [πŸ§‘β€πŸ”¬ Models Directory](/docs/models) | A curated list of models that we recommend using with Tabby | +| [🏷️ API References](/api) | API Documentation | +| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing | +| [πŸ—ΊοΈ Roadmap](/docs/roadmap) | Our future plans | ## πŸ“ Principles @@ -49,7 +49,7 @@ Tabby optimizes the experience for these core users to enhance your team's produ ## 🏘️ Community -- ⭐ Tabby [GitHub repo](https://github.com/TabbyML/tabby) to stay updated about new releases and tutorials. +- ⭐ Tabby [Github repo](https://github.com/TabbyML/tabby) to stay updated about new releases and tutorials. - πŸ™‹ Join the Tabby community on [Slack](https://links.tabbyml.com/join-slack) and get direct support from the community. diff --git a/website/docs/installation/self-host/apple.md b/website/docs/installation/apple.md similarity index 92% rename from website/docs/installation/self-host/apple.md rename to website/docs/installation/apple.md index 15d66a50cc68..8fed35ce4edb 100644 --- a/website/docs/installation/self-host/apple.md +++ b/website/docs/installation/apple.md @@ -1,8 +1,8 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- -# ο£Ώ Homebrew (Apple M1/M2) +# Homebrew (Apple M1/M2) This guide explains how to install Tabby using homebrew. Thanks to Apple's Accelerate and CoreML frameworks, we can now run Tabby on edge devices with reasonable inference speed. Follow the steps below to set it up using homebrew: diff --git a/website/docs/installation/self-host/docker.mdx b/website/docs/installation/docker-compose.mdx similarity index 59% rename from website/docs/installation/self-host/docker.mdx rename to website/docs/installation/docker-compose.mdx index aeed3b5b77a9..8dab5c47b985 100644 --- a/website/docs/installation/self-host/docker.mdx +++ b/website/docs/installation/docker-compose.mdx @@ -2,33 +2,12 @@ sidebar_position: 1 --- -# 🐳 Docker / Docker Compose - -This guide explains how to launch Tabby using docker. +# Docker Compose +This guide explains how to launch Tabby using docker-compose. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - - - ```bash title="run.sh" - docker run -it --gpus all -p 8080:8080 -v $HOME/.tabby:/data tabbyml/tabby serve --model TabbyML/StarCoder-1B --device cuda - ``` - - - - - ```bash title="run.sh" - docker run -it -p 8080:8080 -v $HOME/.tabby:/data tabbyml/tabby serve --model TabbyML/StarCoder-1B - ``` - - - - - -For launching Tabby via docker-compose, please refer to the guidelines below. - diff --git a/website/docs/installation/docker.mdx b/website/docs/installation/docker.mdx new file mode 100644 index 000000000000..7f26f87c0c13 --- /dev/null +++ b/website/docs/installation/docker.mdx @@ -0,0 +1,27 @@ +--- +sidebar_position: 0 +--- + +# Docker + +This guide explains how to launch Tabby using docker. + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + ```bash title="run.sh" + docker run -it --gpus all -p 8080:8080 -v $HOME/.tabby:/data tabbyml/tabby serve --model TabbyML/StarCoder-1B --device cuda + ``` + + + + + ```bash title="run.sh" + docker run -it -p 8080:8080 -v $HOME/.tabby:/data tabbyml/tabby serve --model TabbyML/StarCoder-1B + ``` + + + diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/agent-config.png b/website/docs/installation/hugging-face/agent-config.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/agent-config.png rename to website/docs/installation/hugging-face/agent-config.png diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/code-completion.png b/website/docs/installation/hugging-face/code-completion.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/code-completion.png rename to website/docs/installation/hugging-face/code-completion.png diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/duplicate-space.png b/website/docs/installation/hugging-face/duplicate-space.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/duplicate-space.png rename to website/docs/installation/hugging-face/duplicate-space.png diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/index.md b/website/docs/installation/hugging-face/index.md similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/index.md rename to website/docs/installation/hugging-face/index.md diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/swagger-ui.png b/website/docs/installation/hugging-face/swagger-ui.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/swagger-ui.png rename to website/docs/installation/hugging-face/swagger-ui.png diff --git a/website/docs/installation/self-host/cloud-gpu/hugging-face/tabby-connected.png b/website/docs/installation/hugging-face/tabby-connected.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/hugging-face/tabby-connected.png rename to website/docs/installation/hugging-face/tabby-connected.png diff --git a/website/docs/installation/self-host/cloud-gpu/modal/app-running.png b/website/docs/installation/modal/app-running.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/modal/app-running.png rename to website/docs/installation/modal/app-running.png diff --git a/website/docs/installation/self-host/cloud-gpu/modal/app.py b/website/docs/installation/modal/app.py similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/modal/app.py rename to website/docs/installation/modal/app.py diff --git a/website/docs/installation/self-host/cloud-gpu/modal/index.md b/website/docs/installation/modal/index.md similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/modal/index.md rename to website/docs/installation/modal/index.md diff --git a/website/docs/installation/models/leaderboard.mdx b/website/docs/installation/models/leaderboard.mdx deleted file mode 100644 index dd5b52c6fd3d..000000000000 --- a/website/docs/installation/models/leaderboard.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -sidebar_position: 1 ---- - - -# πŸ“Š Models Leaderboard - - -We build Tabby as a transparent and flexible framework to enable AI coding assistant. -To help users choose the desired LLM, we release [***Coding LLMs Leaderboard***](https://leaderboard.tabbyml.com) as a benchmark for Tabby's users to consider when making trade-offs between quality, licensing, and model size. - - -To learn more about how we built this leaderboard, please refer to our [blogpost](https://tabby.tabbyml.com/blog/2023/11/23/coding-llm-leaderboard). \ No newline at end of file diff --git a/website/docs/installation/self-host/cloud-gpu/index.mdx b/website/docs/installation/self-host/cloud-gpu/index.mdx deleted file mode 100644 index 8a73ebdcb444..000000000000 --- a/website/docs/installation/self-host/cloud-gpu/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -import DocCardList from '@theme/DocCardList'; - -# ☁️ Cloud GPU - - diff --git a/website/docs/installation/self-host/index.mdx b/website/docs/installation/self-host/index.mdx deleted file mode 100644 index 7452f649fc2c..000000000000 --- a/website/docs/installation/self-host/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -import DocCardList from '@theme/DocCardList'; - -# 🏑 Self-hosted Deployment - - diff --git a/website/docs/installation/self-host/cloud-gpu/skypilot/index.md b/website/docs/installation/skypilot/index.md similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/skypilot/index.md rename to website/docs/installation/skypilot/index.md diff --git a/website/docs/installation/self-host/cloud-gpu/skypilot/service-ready.png b/website/docs/installation/skypilot/service-ready.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/skypilot/service-ready.png rename to website/docs/installation/skypilot/service-ready.png diff --git a/website/docs/installation/self-host/cloud-gpu/skypilot/start-service.png b/website/docs/installation/skypilot/start-service.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/skypilot/start-service.png rename to website/docs/installation/skypilot/start-service.png diff --git a/website/docs/installation/self-host/cloud-gpu/skypilot/tabby-ready.png b/website/docs/installation/skypilot/tabby-ready.png similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/skypilot/tabby-ready.png rename to website/docs/installation/skypilot/tabby-ready.png diff --git a/website/docs/installation/self-host/cloud-gpu/skypilot/tabby.yaml b/website/docs/installation/skypilot/tabby.yaml similarity index 100% rename from website/docs/installation/self-host/cloud-gpu/skypilot/tabby.yaml rename to website/docs/installation/skypilot/tabby.yaml diff --git a/website/docs/installation/models/registry.mdx b/website/docs/models/index.mdx similarity index 96% rename from website/docs/installation/models/registry.mdx rename to website/docs/models/index.mdx index fa2fd202aa23..2927a2cd54cc 100644 --- a/website/docs/installation/models/registry.mdx +++ b/website/docs/models/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 0 +sidebar_position: 4 hide_table_of_contents: true --- diff --git a/website/docs/installation/models/readme.tsx b/website/docs/models/readme.tsx similarity index 100% rename from website/docs/installation/models/readme.tsx rename to website/docs/models/readme.tsx diff --git a/website/docs/clients/programming-languages.md b/website/docs/programming-languages.md similarity index 100% rename from website/docs/clients/programming-languages.md rename to website/docs/programming-languages.md diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index da48b834b1f1..c0d5ea75f43f 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -184,45 +184,6 @@ const config = { enableInDevelopment: false, }, ], - [ - '@docusaurus/plugin-client-redirects', - { - redirects: [ - { - to: '/docs/installation/self-host/cloud-gpu/hugging-face/', - from: '/docs/installation/hugging-face/', - }, - { - to: '/docs/installation/self-host/cloud-gpu/modal/', - from: '/docs/installation/modal/', - }, - { - to: '/docs/installation/self-host/cloud-gpu/skypilot/', - from: '/docs/installation/skypilot/', - }, - { - to: '/docs/installation/self-host/apple', - from: '/docs/installation/apple', - }, - { - to: '/docs/installation/self-host/docker', - from: ['/docs/installation/docker', '/docs/installation/docker-compose'], - }, - { - to: '/docs/installation/models/registry', - from: '/docs/models/index', - }, - { - to: '/docs/clients/extensions/', - from: '/docs/extensions/', - }, - { - to: '/docs/programming-languages', - from: '/docs/clients/extensions/programming-languages', - }, - ], - }, - ], ], }; diff --git a/website/package.json b/website/package.json index 8ea2eab31b5e..512ff7b241f7 100644 --- a/website/package.json +++ b/website/package.json @@ -16,7 +16,6 @@ "dependencies": { "@docusaurus/core": "2.4.1", "@docusaurus/preset-classic": "2.4.1", - "@docusaurus/plugin-client-redirects": "2.4.1", "@mdx-js/react": "^1.6.22", "@monaco-editor/react": "^4.5.1", "autoprefixer": "^10.4.14", diff --git a/website/yarn.lock b/website/yarn.lock index c6a32661f159..be2c46dd4b5e 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -1397,21 +1397,6 @@ react-helmet-async "*" react-loadable "npm:@docusaurus/react-loadable@5.5.2" -"@docusaurus/plugin-client-redirects@2.4.1": - version "2.4.1" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-2.4.1.tgz#a28afcc4a1cb7657168ce37a57efd3194c20a53a" - integrity sha512-tp0j16gaLIJ4p+IR0P6KDOFsTOGGMY54MNPnmM61Vaqqt5omLqsuKUO8UlCGU1oW/4EIQOhXYy99XYY5MjE+7A== - dependencies: - "@docusaurus/core" "2.4.1" - "@docusaurus/logger" "2.4.1" - "@docusaurus/utils" "2.4.1" - "@docusaurus/utils-common" "2.4.1" - "@docusaurus/utils-validation" "2.4.1" - eta "^2.0.0" - fs-extra "^10.1.0" - lodash "^4.17.21" - tslib "^2.4.0" - "@docusaurus/plugin-content-blog@2.4.1": version "2.4.1" resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-2.4.1.tgz#c705a8b1a36a34f181dcf43b7770532e4dcdc4a3"