docs: website docs restructure (#1158)

* docs: docs restructure (1/N)

Add installation/self-hosted/cloud-gpu

* docs: restructure Tabby doc

Move existing doc around for docs/installation/ and docs/coding-assistant/.

* docs: enable doc redirects

* docs: fix docker page redirect

* docs: comments addressed with directories renamed.

* docs: update file naming.

website/docs/extensions/configurations.md → website/docs/clients/extensions/configurations.md

@@ -2,7 +2,7 @@
 sidebar_position: 98
 ---
 
-# Advanced Configuration
+# 🛠️ Advanced Configuration
 
 This document describes the available configurations for Tabby IDE extensions.
 

website/docs/extensions/index.mdx → website/docs/clients/extensions/index.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-# 💻 IDE / Editor Extensions
+# 💻 Extensions
 
 import DocCardList from '@theme/DocCardList';
 

website/docs/clients/extensions/installation/index.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# 📦 Installation
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />

website/docs/extensions/installation/intellij.mdx → website/docs/clients/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";
 
 <IntelliJ />

website/docs/extensions/installation/vim.mdx → website/docs/clients/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";
 
 <VIM />

website/docs/extensions/installation/vscode.mdx → website/docs/clients/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";
 
 <VSCode />

website/docs/extensions/troubleshooting.md → website/docs/clients/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.

website/docs/clients/index.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+import DocCardList from '@theme/DocCardList';
+
+# ⌨️ Coding Assistant
+
+<DocCardList />

website/docs/configuration.md

@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-# ⚙️ Configuration
+# ⚙️ Repository Configuration
 
 Tabby server will look for a configuration file at `~/.tabby/config.toml` for advanced features.
 

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/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                                                            |
+| 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                                                            |
 
 ## 📏 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.
 

website/docs/extensions/installation/index.mdx → website/docs/installation/models/index.mdx

@@ -2,8 +2,8 @@
 sidebar_position: 1
 ---
 
-# Installation
-
 import DocCardList from '@theme/DocCardList';
 
+# 📃 Models
+
 <DocCardList />

website/docs/installation/models/leaderboard.mdx

@@ -0,0 +1,13 @@
+---
+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).

website/docs/models/index.mdx → website/docs/installation/models/registry.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 0
 hide_table_of_contents: true
 ---
 

website/docs/installation/apple.md → website/docs/installation/self-host/apple.md

@@ -1,8 +1,8 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 ---
 
-# 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:

website/docs/installation/self-host/cloud-gpu/index.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+import DocCardList from '@theme/DocCardList';
+
+# ☁️ Cloud GPU
+
+<DocCardList />

website/docs/installation/docker-compose.mdx → website/docs/installation/self-host/docker.mdx

@@ -2,12 +2,33 @@
 sidebar_position: 1
 ---
 
-# Docker Compose
-This guide explains how to launch Tabby using docker-compose.
+# 🐳 Docker / Docker Compose
+
+This guide explains how to launch Tabby using docker.
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+<Tabs>
+  <TabItem value="cuda" label="CUDA (requires NVIDIA Container Toolkit)" default>
+
+  ```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
+  ```
+
+  </TabItem>
+  <TabItem value="cpu" label="CPU" default>
+
+  ```bash title="run.sh"
+  docker run -it -p 8080:8080 -v $HOME/.tabby:/data tabbyml/tabby serve --model TabbyML/StarCoder-1B
+  ```
+
+  </TabItem>
+</Tabs>
+
+
+For launching Tabby via docker-compose, please refer to the guidelines below.
+
 <Tabs>
   <TabItem value="cuda" label="CUDA (requires NVIDIA Container Toolkit)">
 

website/docs/installation/self-host/index.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+import DocCardList from '@theme/DocCardList';
+
+# 🏡 Self-hosted Deployment
+
+<DocCardList />

website/docusaurus.config.js

@@ -184,6 +184,45 @@ 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',
+          },
+        ],
+      },
+    ],
   ],
 };
 

website/package.json

@@ -16,6 +16,7 @@
   "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",

website/yarn.lock

@@ -1397,6 +1397,21 @@
     react-helmet-async "*"
     react-loadable "npm:@docusaurus/[email protected]"
 
+"@docusaurus/[email protected]":
+  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/[email protected]":
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-2.4.1.tgz#c705a8b1a36a34f181dcf43b7770532e4dcdc4a3"