diff --git a/website/docs/01-getting-started.md b/website/docs/01-getting-started.md index 8416016..67a4546 100644 --- a/website/docs/01-getting-started.md +++ b/website/docs/01-getting-started.md @@ -1,7 +1,31 @@ # πŸ‘‹ Getting Started -Install Tabby in your code editors, if your favorite editor is not supported yet, consider filing an [Feature Request](https://github.com/TabbyML/tabby/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=). +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. -* [VSCode Extension](https://github.com/TabbyML/tabby/tree/main/clients/vscode) – Install from the [marketplace](https://marketplace.visualstudio.com/items?itemName=TabbyML.vscode-tabby), or [open-vsx.org](https://open-vsx.org/extension/TabbyML/vscode-tabby) -* [VIM Extension](https://github.com/TabbyML/tabby/tree/main/clients/vim) -* [IntelliJ Platform Plugin](https://github.com/TabbyML/tabby/tree/main/clients/intellij) – Install from the [marketplace](https://plugins.jetbrains.com/plugin/22379-tabby) +[![Join Slack](https://shields.io/badge/Join%20Slack-e29351?logo=slack)](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) +[![Follow on Linkedin](https://shields.io/badge/Follow%20on%20Linkedin-e29351?logo=linkedin)](https://www.linkedin.com/company/tabbyml/) +[![Star on Github](https://img.shields.io/github/stars/TabbyML/tabby?labelColor=e29351&label=Star&color=ffffff&logo=github)](https://github.com/TabbyML/tabby) + +## πŸ“ Principles +* **Open**: Tabby is free, open-source, and compatible with major Coding LLMs (CodeLlama, StarCoder, CodeGen). In fact, you can use and combine your preferred models without implementing anything by yourself. + +* **End-to-End**: While most coding tools consider code completion merely as a thin wrapper atop Coding LLMs, in real-world scenarios, optimizations in IDE extensions can be just as crucial as the capabilities of Coding LLMs. +Tabby optimizes the entire serving stack: + + IDE extensions: Tabby achieves accurate streaming and cancellation with an adaptive caching strategy to ensure rapid completion (in less than a second). + + Model serving: Tabby parses relevant code into Tree Sitter tags to provide effective prompts. + +* **User and Developer Experience**: The key to sustainable open-source solutions is to make it easier for everyone to contribute to projects. +AI experts should feel comfortable understanding and improving the suggestion quality. +EngOps team should find it easy to set up and feel in control of the data. +Developers should have an "aha" moment during coding time. +Tabby optimizes the experience for these core users to enhance your team's productivity. + +## 🏘️ Community + +⭐ Tabby [Github repo](https://github.com/TabbyML/tabby) to stay updated about new releases and tutorials. + +πŸ™‹ Join the Tabby community on [Slack](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and get direct support from the community. + + +## πŸ—ΊοΈ Roadmap +We continuously work on updating [our roadmap](./roadmap) and we love to discuss those with our community. Feel encouraged to participate. diff --git a/website/docs/02-self-hosting/02-self-hosting.md b/website/docs/02-self-hosting/index.md similarity index 100% rename from website/docs/02-self-hosting/02-self-hosting.md rename to website/docs/02-self-hosting/index.md