docs: Crate doc comments (#1168)

* doc: Add basic doc comments describing most of the tabby crates

* Apply suggestions from code review

Co-authored-by: Meng Zhang <[email protected]>

---------

Co-authored-by: Meng Zhang <[email protected]>

crates/llama-cpp-bindings/src/lib.rs

@@ -1,3 +1,4 @@
+//! Bindings to raw C++ LLaMA implementation. implements the TextGeneration trait and being used in tabby to generate text / code.
 mod llama;
 mod utils;
 

crates/tabby-common/src/lib.rs

@@ -1,3 +1,5 @@
+//! Common tabby types and utilities.
+//! Defines common types and utilities used across multiple tabby subprojects, especially serialization and deserialization targets.
 pub mod api;
 pub mod config;
 pub mod index;

crates/tabby-download/src/lib.rs

@@ -1,3 +1,4 @@
+//! Responsible for downloading ML models for use with tabby.
 use std::{fs, path::Path};
 
 use aim_downloader::{bar::WrappedBar, https};

crates/tabby-inference/src/lib.rs

@@ -1,3 +1,4 @@
+//! Lays out the abstract definition of a text generation model, and utilities for encodings.
 pub mod decoding;
 
 use async_trait::async_trait;

crates/tabby-scheduler/src/lib.rs

@@ -1,3 +1,5 @@
+//! Responsible for scheduling all of the background jobs for tabby.
+//! Includes syncing respositories and updating indices.
 mod dataset;
 mod index;
 mod repository;

crates/tabby/src/main.rs

@@ -1,3 +1,4 @@
+//! Core tabby functionality. Defines primary API and CLI behavior.
 mod routes;
 mod services;
 

ee/tabby-webserver/src/lib.rs

@@ -1,3 +1,5 @@
+//! Defines behavior for the tabby webserver which allows users to interact with enterprise features.
+//! Using the web interface (e.g chat playground) requires using this module with the `--webserver` flag on the command line.
 mod handler;
 mod hub;
 mod oauth;