diff --git a/clients/vim/README.md b/clients/vim/README.md index 890dfb7182d2..0bd82d52557b 100644 --- a/clients/vim/README.md +++ b/clients/vim/README.md @@ -5,7 +5,7 @@ If you encounter any problem or have any suggestion, please [open an issue](http ## Table of Contents -- [Tabby Plugin for Vim and NeoVim](#tabby-plugin-for-vim-and-neovim) +- Tabby Plugin for Vim and NeoVim - [Table of Contents](#table-of-contents) - [Requirements](#requirements) - [Installation](#installation) diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/index.md b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/index.md index 595f641ee0c8..3f3172dac0ba 100644 --- a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/index.md +++ b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/index.md @@ -25,7 +25,7 @@ Let’s firstly take a look at what steps are needed to deploy a Tabby instance **Step 3:** After space is built, you will be able to send requests to the APIs. -That's it! With the hosted APIs, now you can connect Tabby's [IDE extensions](/docs/getting-started) to the API endpoint. Next, we will deep dive into each step with screenshots!! +That's it! With the hosted APIs, now you can connect Tabby's [IDE extensions](/docs/extensions/installation/vscode) to the API endpoint. Next, we will deep dive into each step with screenshots!! **Everything will be done in the Hugging Face UI. No local setup is needed.** :::tip diff --git a/website/blog/2023-10-16-repository-context-for-code-completion/index.md b/website/blog/2023-10-16-repository-context-for-code-completion/index.md index 949354b54a75..1d2fecbc8f6f 100644 --- a/website/blog/2023-10-16-repository-context-for-code-completion/index.md +++ b/website/blog/2023-10-16-repository-context-for-code-completion/index.md @@ -159,5 +159,5 @@ We are incredibly enthusiastic about the potential for enhancing the quality and ## Give it a try To use this repository context feature: -1. Installing [tabby](/docs/installation/). +1. Installing [tabby](/docs/quick-start/installation/docker). 2. Navigate to the [Repository Context](/docs/administration/context) page and follow the instructions to set it up. \ No newline at end of file diff --git a/website/docs/administration/_category_.yml b/website/docs/administration/_category_.yml new file mode 100644 index 000000000000..fa0328bec684 --- /dev/null +++ b/website/docs/administration/_category_.yml @@ -0,0 +1,2 @@ +label: πŸ”§ Administration +position: 3 \ No newline at end of file diff --git a/website/docs/administration/assets/webserver-running.png b/website/docs/administration/assets/webserver-running.png deleted file mode 100644 index 4270f237aa77..000000000000 --- a/website/docs/administration/assets/webserver-running.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:eba28932dfba790240696338a9790b12ee390f69516d703a09fea5c14a5e1861 -size 148728 diff --git a/website/docs/administration/index.md b/website/docs/administration/index.md deleted file mode 100644 index 2c2d4c9aeeab..000000000000 --- a/website/docs/administration/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 3 ---- - -# πŸ”§ Administration - -Tabby comes with an enhanced experience with a full feature UI interface and many enterprise facing features. - -![webserver](./assets/webserver-running.png) diff --git a/website/docs/configuration.md b/website/docs/administration/usage-collection.md similarity index 87% rename from website/docs/configuration.md rename to website/docs/administration/usage-collection.md index bd78f6e4ebe6..94652353b1a4 100644 --- a/website/docs/configuration.md +++ b/website/docs/administration/usage-collection.md @@ -1,13 +1,7 @@ ---- -sidebar_position: 5 ---- - -# βš™οΈ Configuration - -## Usage Collection +# Usage Collection Tabby collects usage stats by default. This data will only be used by the Tabby team to improve its services. -### What data is collected? +## What data is collected? We collect non-sensitive data that helps us understand how Tabby is used. For now we collects `serve` command you used to start the server. As of the date 04/18/2024, the following information has been collected: @@ -27,5 +21,5 @@ struct HealthState { For an up-to-date list of the fields we have collected, please refer to [health.rs](https://github.com/TabbyML/tabby/blob/main/crates/tabby/src/services/health.rs#L11). -### How to disable it +## How to disable it To disable usage collection, set the `TABBY_DISABLE_USAGE_COLLECTION` environment variable by `export TABBY_DISABLE_USAGE_COLLECTION=1`. \ No newline at end of file diff --git a/website/docs/extensions/_category_.yml b/website/docs/extensions/_category_.yml new file mode 100644 index 000000000000..58de7e21fcd8 --- /dev/null +++ b/website/docs/extensions/_category_.yml @@ -0,0 +1,2 @@ +label: πŸ’» IDE / Editor Extensions +position: 3 \ No newline at end of file diff --git a/website/docs/extensions/index.mdx b/website/docs/extensions/index.mdx deleted file mode 100644 index 9c12acfb29bc..000000000000 --- a/website/docs/extensions/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 3 ---- - -# πŸ’» IDE / Editor Extensions - -import DocCardList from '@theme/DocCardList'; - - diff --git a/website/docs/extensions/installation/_category_.yml b/website/docs/extensions/installation/_category_.yml new file mode 100644 index 000000000000..f48e027a1b8f --- /dev/null +++ b/website/docs/extensions/installation/_category_.yml @@ -0,0 +1,2 @@ +label: Installation +position: 1 \ No newline at end of file diff --git a/website/docs/extensions/installation/index.mdx b/website/docs/extensions/installation/index.mdx deleted file mode 100644 index 369993aae8b8..000000000000 --- a/website/docs/extensions/installation/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Installation - -import DocCardList from '@theme/DocCardList'; - - diff --git a/website/docs/installation/index.mdx b/website/docs/installation/index.mdx deleted file mode 100644 index 6c1055525fcb..000000000000 --- a/website/docs/installation/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -import DocCardList from '@theme/DocCardList'; - -# πŸ“š Installation - - diff --git a/website/docs/installation/windows/status.png b/website/docs/installation/windows/status.png deleted file mode 100644 index 7ea0a70b8772..000000000000 --- a/website/docs/installation/windows/status.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:d1fb58659c9b61189abf9d6516cccb2a08102f227842d991ab120fef0187e24e -size 39288 diff --git a/website/docs/quick-start/_category_.yml b/website/docs/quick-start/_category_.yml new file mode 100644 index 000000000000..e9e4c7c28c18 --- /dev/null +++ b/website/docs/quick-start/_category_.yml @@ -0,0 +1,2 @@ +label: πŸš€ Quick Start +position: 2 diff --git a/website/docs/quick-start/code-completion.png b/website/docs/quick-start/code-completion.png new file mode 100644 index 000000000000..bf2de0bd1192 --- /dev/null +++ b/website/docs/quick-start/code-completion.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de39259dd3d38f88111261aeeee00ae12660e101ea0acd9152887416e131e79b +size 12194 diff --git a/website/docs/quick-start/connect-success.png b/website/docs/quick-start/connect-success.png new file mode 100644 index 000000000000..c714de7bd402 --- /dev/null +++ b/website/docs/quick-start/connect-success.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc3585d74087464cbf6c010d4eaf7b6e6f311c569e29ddfa5fd6ade0e9219d8d +size 3606 diff --git a/website/docs/quick-start/installation/_category_.yml b/website/docs/quick-start/installation/_category_.yml new file mode 100644 index 000000000000..85fb42f1e3c0 --- /dev/null +++ b/website/docs/quick-start/installation/_category_.yml @@ -0,0 +1,2 @@ +label: Step 1 - Installation +position: 1 \ No newline at end of file diff --git a/website/docs/installation/apple.md b/website/docs/quick-start/installation/apple.md similarity index 90% rename from website/docs/installation/apple.md rename to website/docs/quick-start/installation/apple.md index fe9d71d103a8..ff8bdd27254e 100644 --- a/website/docs/installation/apple.md +++ b/website/docs/quick-start/installation/apple.md @@ -11,7 +11,7 @@ Thanks to Apple's Accelerate and CoreML frameworks, we can now run Tabby on edge brew install tabbyml/tabby/tabby # Start server with StarCoder-1B -tabby serve --device metal --model StarCoder-1B --no-webserver +tabby serve --device metal --model StarCoder-1B ``` The compute power of M1/M2 is limited and is likely to be sufficient only for individual usage. If you require a shared instance for a team, we recommend considering Docker hosting with CUDA or ROCm. You can find more information about Docker [here](../docker). diff --git a/website/docs/installation/docker-compose.mdx b/website/docs/quick-start/installation/docker-compose.mdx similarity index 90% rename from website/docs/installation/docker-compose.mdx rename to website/docs/quick-start/installation/docker-compose.mdx index 2ee164895164..97f348f8db33 100644 --- a/website/docs/installation/docker-compose.mdx +++ b/website/docs/quick-start/installation/docker-compose.mdx @@ -22,7 +22,7 @@ services: tabby: restart: always image: tabbyml/tabby - command: serve --model StarCoder-1B --device cuda --no-webserver + command: serve --model StarCoder-1B --device cuda volumes: - "$HOME/.tabby:/data" ports: @@ -47,7 +47,7 @@ services: restart: always image: tabbyml/tabby entrypoint: /opt/tabby/bin/tabby-cpu - command: serve --model StarCoder-1B --no-webserver + command: serve --model StarCoder-1B volumes: - "$HOME/.tabby:/data" ports: diff --git a/website/docs/installation/docker.mdx b/website/docs/quick-start/installation/docker.mdx similarity index 84% rename from website/docs/installation/docker.mdx rename to website/docs/quick-start/installation/docker.mdx index 62c51fc5eab0..4ff5aa3f7cd1 100644 --- a/website/docs/installation/docker.mdx +++ b/website/docs/quick-start/installation/docker.mdx @@ -19,7 +19,7 @@ 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 StarCoder-1B --device cuda --no-webserver + tabbyml/tabby serve --model StarCoder-1B --device cuda ``` @@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem'; ```bash title="run.sh" docker run --entrypoint /opt/tabby/bin/tabby-cpu -it \ -p 8080:8080 -v $HOME/.tabby:/data \ - tabbyml/tabby serve --model StarCoder-1B --no-webserver + tabbyml/tabby serve --model StarCoder-1B ``` diff --git a/website/docs/installation/hugging-face/agent-config.png b/website/docs/quick-start/installation/hugging-face/agent-config.png similarity index 100% rename from website/docs/installation/hugging-face/agent-config.png rename to website/docs/quick-start/installation/hugging-face/agent-config.png diff --git a/website/docs/installation/hugging-face/code-completion.png b/website/docs/quick-start/installation/hugging-face/code-completion.png similarity index 100% rename from website/docs/installation/hugging-face/code-completion.png rename to website/docs/quick-start/installation/hugging-face/code-completion.png diff --git a/website/docs/installation/hugging-face/duplicate-space.png b/website/docs/quick-start/installation/hugging-face/duplicate-space.png similarity index 100% rename from website/docs/installation/hugging-face/duplicate-space.png rename to website/docs/quick-start/installation/hugging-face/duplicate-space.png diff --git a/website/docs/installation/hugging-face/index.md b/website/docs/quick-start/installation/hugging-face/index.md similarity index 100% rename from website/docs/installation/hugging-face/index.md rename to website/docs/quick-start/installation/hugging-face/index.md diff --git a/website/docs/installation/hugging-face/swagger-ui.png b/website/docs/quick-start/installation/hugging-face/swagger-ui.png similarity index 100% rename from website/docs/installation/hugging-face/swagger-ui.png rename to website/docs/quick-start/installation/hugging-face/swagger-ui.png diff --git a/website/docs/installation/hugging-face/tabby-connected.png b/website/docs/quick-start/installation/hugging-face/tabby-connected.png similarity index 100% rename from website/docs/installation/hugging-face/tabby-connected.png rename to website/docs/quick-start/installation/hugging-face/tabby-connected.png diff --git a/website/docs/installation/modal/app-running.png b/website/docs/quick-start/installation/modal/app-running.png similarity index 100% rename from website/docs/installation/modal/app-running.png rename to website/docs/quick-start/installation/modal/app-running.png diff --git a/website/docs/installation/modal/app.py b/website/docs/quick-start/installation/modal/app.py similarity index 98% rename from website/docs/installation/modal/app.py rename to website/docs/quick-start/installation/modal/app.py index fda968557565..d305635b7c4a 100644 --- a/website/docs/installation/modal/app.py +++ b/website/docs/quick-start/installation/modal/app.py @@ -60,7 +60,6 @@ def app(): "cuda", "--parallelism", "4", - "--no-webserver", ] ) diff --git a/website/docs/installation/modal/index.md b/website/docs/quick-start/installation/modal/index.md similarity index 99% rename from website/docs/installation/modal/index.md rename to website/docs/quick-start/installation/modal/index.md index ee471c717ba8..1fff6396b9db 100644 --- a/website/docs/installation/modal/index.md +++ b/website/docs/quick-start/installation/modal/index.md @@ -103,7 +103,6 @@ def app(): "8000", "--device", "cuda", - "--no-webserver", ] ) diff --git a/website/docs/installation/skypilot/index.md b/website/docs/quick-start/installation/skypilot/index.md similarity index 97% rename from website/docs/installation/skypilot/index.md rename to website/docs/quick-start/installation/skypilot/index.md index 0ee1fc181619..d596b84c6c2d 100644 --- a/website/docs/installation/skypilot/index.md +++ b/website/docs/quick-start/installation/skypilot/index.md @@ -35,7 +35,7 @@ Finally, we define the command line that actually initiates the container job: run: | docker run --gpus all -p 8080:8080 -v ~/.tabby:/data \ tabbyml/tabby \ - serve --model TabbyML/StarCoder-1B --device cuda --no-webserver + serve --model TabbyML/StarCoder-1B --device cuda ``` ## Launch the service diff --git a/website/docs/installation/skypilot/service-ready.png b/website/docs/quick-start/installation/skypilot/service-ready.png similarity index 100% rename from website/docs/installation/skypilot/service-ready.png rename to website/docs/quick-start/installation/skypilot/service-ready.png diff --git a/website/docs/installation/skypilot/start-service.png b/website/docs/quick-start/installation/skypilot/start-service.png similarity index 100% rename from website/docs/installation/skypilot/start-service.png rename to website/docs/quick-start/installation/skypilot/start-service.png diff --git a/website/docs/installation/skypilot/tabby-ready.png b/website/docs/quick-start/installation/skypilot/tabby-ready.png similarity index 100% rename from website/docs/installation/skypilot/tabby-ready.png rename to website/docs/quick-start/installation/skypilot/tabby-ready.png diff --git a/website/docs/installation/skypilot/tabby.yaml b/website/docs/quick-start/installation/skypilot/tabby.yaml similarity index 100% rename from website/docs/installation/skypilot/tabby.yaml rename to website/docs/quick-start/installation/skypilot/tabby.yaml diff --git a/website/docs/installation/windows/assets.png b/website/docs/quick-start/installation/windows/assets.png similarity index 100% rename from website/docs/installation/windows/assets.png rename to website/docs/quick-start/installation/windows/assets.png diff --git a/website/docs/installation/windows/index.mdx b/website/docs/quick-start/installation/windows/index.mdx similarity index 76% rename from website/docs/installation/windows/index.mdx rename to website/docs/quick-start/installation/windows/index.mdx index f84b2c7d62af..e1ea5c6d3b76 100644 --- a/website/docs/installation/windows/index.mdx +++ b/website/docs/quick-start/installation/windows/index.mdx @@ -5,12 +5,12 @@ sidebar_position: 3 # Windows Running Tabby on Windows using Tabby's exe distribution. -## 1. Find the Windows release +## Find the Windows release * Go to the Tabby release page: https://github.com/TabbyML/tabby/releases * Click on the **Assets** dropdown for a specific release to find the Windows executable (exe) files. ![Windows release](./assets.png) -## 2. Download the release +## Download the release * If you are using a CPU-only system, download the **tabby_x86_64-windows-msvc.exe file**. * If you are using a GPU-enabled system, download the **tabby_x86_64-windows-msvc-cuda117.exe** file, In this example, we assume you are using CUDA 11.7. @@ -22,12 +22,12 @@ Running Tabby on Windows using Tabby's exe distribution. nvcc --version ``` -## 3. Running Tabby locally +## Running Tabby Open a command prompt or PowerShell window in the directory where you downloaded the Tabby executable. Run the following command: ``` -.\tabby_x86_64-windows-msvc-cuda117.exe serve --model StarCoder-1B --device cuda --no-webserver -``` -You should see the following output if the command runs successfully: -![Windows running output](./status.png) +# For CPU-only environments +.\tabby_x86_64-windows-msvc.exe serve --model StarCoder-1B -You can also go to `http://localhost:8080/swagger-ui/` to check the available API endpoints. +# For CUDA-enabled environments +.\tabby_x86_64-windows-msvc-cuda117.exe serve --model StarCoder-1B --device cuda +``` \ No newline at end of file diff --git a/website/docs/quick-start/personal-token.png b/website/docs/quick-start/personal-token.png new file mode 100644 index 000000000000..ff1558c62423 --- /dev/null +++ b/website/docs/quick-start/personal-token.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b037f064b948a5d64646f79df1a9814c6617cbc951e038822f5725cf9de4aefb +size 26749 diff --git a/website/docs/quick-start/register-account/admin-ui.png b/website/docs/quick-start/register-account/admin-ui.png new file mode 100644 index 000000000000..ee1d021d4ba1 --- /dev/null +++ b/website/docs/quick-start/register-account/admin-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2860c2e7137397ab91fb53ee7d5496dcf6ee035abcbb640285dbd024fa3203d +size 342022 diff --git a/website/docs/quick-start/register-account/homepage.png b/website/docs/quick-start/register-account/homepage.png new file mode 100644 index 000000000000..48e82ca76f85 --- /dev/null +++ b/website/docs/quick-start/register-account/homepage.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4174af900fe41c6c6f0b311f67be8e047ec70c8565e5ce039a538b86a2f5086c +size 265993 diff --git a/website/docs/quick-start/register-account/index.md b/website/docs/quick-start/register-account/index.md new file mode 100644 index 000000000000..9a9ad94791ad --- /dev/null +++ b/website/docs/quick-start/register-account/index.md @@ -0,0 +1,31 @@ +--- +sidebar_label: Step 2 - Register Account +sidebar_position: 2 +--- + +import SetupAdmin from './setup-admin.png'; +import Homepage from './homepage.png'; + +# Registering Accounts + +After deploying Tabby, you will need to register an account to access the instance. + +## Creating an Admin Account + +The first registered account after deployment will be the admin account and will be granted the **owner** role. + +Setup Admin + +## Entering Homepage + +Once logged in, you will be redirected to the homepage. It contains basic information about your account. More importantly, you will find the credentials you need to connect your IDE/Editor extensions to Tabby. + +![Homepage](homepage.png) + +## (Optional) Advanced Configuration + +Tabby offers an enhanced experience with a full-featured UI interface and many enterprise-facing features. To access the admin UI, click on **Settings** in the left sidebar. + +![Admin UI](admin-ui.png) + +For more information on how to configure the instance, please refer to the [Administration](/docs/administration/upgrade) documentation. diff --git a/website/docs/quick-start/register-account/setup-admin.png b/website/docs/quick-start/register-account/setup-admin.png new file mode 100644 index 000000000000..2f7ad1fc6d76 --- /dev/null +++ b/website/docs/quick-start/register-account/setup-admin.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:714de4608d124b18dad133b0453835af102f8fc5d73705029b23552e269488af +size 92202 diff --git a/website/docs/quick-start/setup-endpoint.png b/website/docs/quick-start/setup-endpoint.png new file mode 100644 index 000000000000..2d89246039ef --- /dev/null +++ b/website/docs/quick-start/setup-endpoint.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a190c268bc37cc8036a2790fc759d838492149a8f6b6bf48f839fdc9ea1549ad +size 107908 diff --git a/website/docs/quick-start/setup-ide.md b/website/docs/quick-start/setup-ide.md new file mode 100644 index 000000000000..277da829e5da --- /dev/null +++ b/website/docs/quick-start/setup-ide.md @@ -0,0 +1,24 @@ +--- +sidebar_label: Step 3 - Connect IDE / Editor Extensions +sidebar_position: 3 +--- + +# Connect IDE / Editor Extensions + +Once you have registered your account, you can now connect your IDE / Editor extensions to Tabby. To do this, please follow the installation guide for [IDE / Editor Extensions](/docs/extensions/installation/vscode). In this example, we'll use VSCode. + +In the extension settings, you need to fill in the Endpoint provided on the homepage. This Endpoint is essential for establishing a connection between your IDE / Editor and Tabby. + +![Setup Endpoint](setup-endpoint.png) + +Once you have entered the Endpoint, you will receive a notification indicating that an access token is required. This access token is to authenticate you as a user of Tabby. Click on the **Set Credentials** button and enter the token acquired from the homepage. + +![Personal Token](personal-token.png) + +After setting the token, you will see a connected icon in the status bar of your IDE / Editor, indicating a successful connection with Tabby. + +![Connected](connect-success.png) + +Congratulations! You have completed the setup process. Now, you can enjoy the benefits of code completion with Tabby, making your coding experience more efficient and productive. + +![Code Completion](code-completion.png) \ No newline at end of file diff --git a/website/docs/getting-started.mdx b/website/docs/welcome.mdx similarity index 70% rename from website/docs/getting-started.mdx rename to website/docs/welcome.mdx index a36514d440c9..c227d49f5896 100644 --- a/website/docs/getting-started.mdx +++ b/website/docs/welcome.mdx @@ -2,7 +2,7 @@ sidebar_position: 0 --- -# πŸ‘‹ Getting Started +# πŸ‘‹ What's Tabby Tabby is an open-source, self-hosted AI coding assistant. With Tabby, every team can set up its own LLM-powered code completion server with ease. @@ -24,14 +24,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) | Checkout Tabby API Documentation | -| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing | -| [πŸ—ΊοΈ Roadmap](/docs/roadmap) | Our future plans | +| Section | Goal | +| ------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| [πŸ“š Installation](/docs/quick-start/installation/docker) | Everything deployment: Docker, Homebrew, Hugging Face Space and many others | +| [πŸ’» IDE / Editor Extensions](/docs/extensions/installation/vscode) | 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) | Checkout Tabby API Documentation | +| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing | +| [πŸ—ΊοΈ Roadmap](/docs/roadmap) | Our future plans | ## πŸ“ Principles diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 35e648c2133d..bf125ec5bf42 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -78,6 +78,11 @@ export default { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ image: 'img/tabby-social-card.png', + docs: { + sidebar: { + autoCollapseCategories: true + }, + }, navbar: { logo: { alt: 'Tabby', @@ -110,7 +115,7 @@ export default { items: [ { label: 'Docs', - to: '/docs/getting-started', + to: '/docs/welcome', }, { label: 'Playground', @@ -196,14 +201,46 @@ export default { from: '/blog/running-tabby-as-a-language-server' }, { - to: '/docs/installation/docker', + to: '/docs/quick-start/installation/docker', from: '/docs/self-hosting/docker' }, { to: '/docs/extensions/installation/vscode', from: '/docs/extensions/vscode' }, - ] + { + to: '/docs/administration/usage-collection', + from: '/docs/configurations' + }, + { + to: '/docs/welcome', + from: '/docs/getting-started' + }, + { + to: '/docs/extensions/installation/vscode', + from: '/docs/extensions' + }, + { + to: '/docs/extensions/installation/vscode', + from: '/docs/extensions/installation' + }, + { + to: '/docs/quick-start/installation/docker', + from: '/docs/installation' + }, + { + to: '/docs/administration/upgrade', + from: '/docs/administration' + } + ], + createRedirects(existingPath) { + // Create redirection from /docs/installation/* to /docs/quick-start/installation/* + if (existingPath.startsWith("/docs/quick-start/installation")) { + return [ + existingPath.replace("/docs/quick-start/installation", "/docs/installation"), + ] + } + } }, ], ], diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 44355f80e819..48894b198255 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -24,7 +24,7 @@ function HomepageHeader() { + to="/docs/welcome"> Tutorial - 5min ⏱️