[Feat] Add api and core doc (#134)

* add api doc

* fix doc test

* cleanup and add doc for bothan-core

* fix query_id

* use lowercase for command

* fixed from comment

---------

Co-authored-by: Kitipong Sirirueangsakul <kitipong.sirir@gmail.com>

Author: colmazia

bothan-api/client/go-client/client.go

@@ -2,6 +2,9 @@ package client
 
 import proto "github.com/bandprotocol/bothan/bothan-api/client/go-client/proto/bothan/v1"
 
+// Client defines the interface for interacting with the Bothan API client.
+// It provides methods to retrieve information, update the registry, push monitoring records,
+// and fetch prices for given signal IDs.
 type Client interface {
 	GetInfo() (*proto.GetInfoResponse, error)
 	UpdateRegistry(ipfsHash string, version string) error

bothan-api/client/rust-client/src/client.rs

@@ -1,6 +1,53 @@
+//! Bothan API Rust client module.
+//!
+//! Provides gRPC and REST client implementations.
+//!
+//! ## Components
+//!
+//! - **GrpcClient**: High-performance gRPC client for binary protocol communication
+//! - **RestClient**: HTTP-based REST client for JSON API interactions
+//!
+//! ## Protocol Support
+//!
+//! ### gRPC Client
+//!
+//! The gRPC client provides:
+//! - Binary protocol for maximum performance
+//! - Streaming support for real-time data
+//! - Strong typing with protocol buffers
+//! - Connection pooling and load balancing
+//!
+//! ### REST Client
+//!
+//! The REST client provides:
+//! - HTTP/JSON interface for easy integration
+//! - Standard REST conventions
+//! - Browser-friendly API access
+//! - Simple authentication and headers
+//!
+//! ## Usage Examples
+//!
+//! ```rust,no_run
+//! use bothan_client::client::{GrpcClient, RestClient};
+//!
+//! #[tokio::main]
+//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
+//!     // gRPC client
+//!     let grpc_client = GrpcClient::connect("http://localhost:9090").await?;
+//!     
+//!     // REST client
+//!     let rest_client = RestClient::new("http://localhost:8080".to_string());
+//!     
+//!     Ok(())
+//! }
+//! ```
+
 #![allow(unused_imports)]
 #![allow(dead_code)]
+
+/// gRPC client for Bothan API Server communication
 pub use grpc::GrpcClient;
+/// REST client for Bothan API Server communication
 pub use rest::RestClient;
 
 mod grpc;

bothan-api/client/rust-client/src/client/grpc.rs

@@ -1,3 +1,7 @@
+//! Bothan API Rust gRPC client implementation.
+//!
+//! Provides async gRPC client for Bothan API Server.
+
 use std::str::FromStr;
 use std::sync::Arc;
 
@@ -14,6 +18,7 @@ pub struct GrpcClient {
     client: Arc<Mutex<BothanServiceClient<Channel>>>,
 }
 
+/// Async gRPC client for Bothan API Server.
 impl GrpcClient {
     pub fn new(client: BothanServiceClient<Channel>) -> Self {
         Self {

bothan-api/client/rust-client/src/client/rest.rs

@@ -1,3 +1,7 @@
+//! Bothan API Rust REST client implementation.
+//!
+//! Provides async REST client for Bothan API Server.
+
 use reqwest::{Client, Error};
 use url::{ParseError, Url};
 
@@ -8,6 +12,7 @@ pub struct RestClient {
     client: Client,
 }
 
+/// Async REST client for Bothan API Server.
 impl RestClient {
     pub fn new(url: String) -> Result<Self, ParseError> {
         Ok(RestClient {

bothan-api/client/rust-client/src/lib.rs

@@ -1,2 +1,6 @@
+//! Bothan API Rust client library root.
+//!
+//! Provides async Rust clients for the Bothan API Server (gRPC and REST), with protocol buffer bindings.
+
 pub mod client;
 pub mod proto;

bothan-api/client/rust-client/src/proto.rs

@@ -1,3 +1,7 @@
+//! Bothan API Rust client protocol buffer bindings.
+//!
+//! Contains generated proto code and client re-exports.
+
 #![allow(clippy::all)]
 pub mod bothan {
     pub mod v1 {

bothan-api/server-cli/src/commands.rs

@@ -1,3 +1,7 @@
+//! Bothan CLI command module.
+//!
+//! Exposes submodules for all CLI subcommands: config, key, query, request, and start.
+
 pub mod config;
 pub mod key;
 pub mod query;

bothan-api/server-cli/src/commands/config.rs

@@ -1,3 +1,7 @@
+//! Bothan CLI config subcommand module.
+//!
+//! Initialize and manage the Bothan API server configuration file.
+
 use std::fs::{create_dir_all, write};
 use std::path::PathBuf;
 
@@ -9,12 +13,14 @@ use clap::{Parser, Subcommand};
 use crate::bothan_home_dir;
 
 #[derive(Parser)]
+/// CLI arguments for the `config` command.
 pub struct ConfigCli {
     #[command(subcommand)]
     subcommand: ConfigSubCommand,
 }
 
 #[derive(Subcommand)]
+/// Supported config subcommands.
 enum ConfigSubCommand {
     /// Initialize the configuration file.
     Init {
@@ -29,6 +35,7 @@ enum ConfigSubCommand {
 }
 
 impl ConfigCli {
+    /// Runs the config command.
     pub async fn run(&self) -> anyhow::Result<()> {
         match &self.subcommand {
             ConfigSubCommand::Init { path, override_ } => {

bothan-api/server-cli/src/commands/key.rs

@@ -1,3 +1,7 @@
+//! Bothan CLI key subcommand module.
+//!
+//! Generate, export, import, and display monitoring keys.
+
 use std::fs::{create_dir_all, read, read_to_string, write};
 
 use anyhow::{Context, anyhow};
@@ -7,12 +11,14 @@ use clap::{Parser, Subcommand};
 use inquire::{Password, PasswordDisplayMode};
 
 #[derive(Parser)]
+/// CLI arguments for the `key` command.
 pub struct KeyCli {
     #[command(subcommand)]
     subcommand: KeySubCommand,
 }
 
 #[derive(Subcommand)]
+/// Supported key subcommands.
 enum KeySubCommand {
     /// Generates a new monitoring key
     Generate {
@@ -33,6 +39,7 @@ enum KeySubCommand {
 }
 
 impl KeyCli {
+    /// Runs the key command.
     pub async fn run(&self, app_config: AppConfig) -> anyhow::Result<()> {
         match &self.subcommand {
             KeySubCommand::Generate { override_ } => generate_key(&app_config, *override_),

bothan-api/server-cli/src/commands/query.rs

@@ -1,3 +1,22 @@
+//! Bothan CLI query subcommand module.
+//!
+//! Query prices and asset info from supported exchanges and data sources.
+//!
+//! Supports querying prices from multiple exchanges and data sources with customizable timeout and pretty-printed output.
+//!
+//! ## Features
+//!
+//! - Query prices from Binance, Bitfinex, Bybit, Coinbase, CoinGecko, CoinMarketCap, HTX, Kraken, OKX
+//! - Customizable timeout and query IDs
+//! - Pretty-printed table output
+//!
+//! ## Usage
+//!
+//! ```bash
+//! bothan query binance BTCUSDT ETHUSDT
+//! bothan query coingecko bitcoin ethereum
+//! ```
+
 use std::collections::{HashMap, HashSet};
 use std::error::Error;
 use std::sync::Arc;
@@ -20,12 +39,14 @@ use tokio::time::timeout;
 const DEFAULT_TIMEOUT: &str = "10s";
 
 #[derive(Parser)]
+/// CLI arguments for the `query` command.
 pub struct QueryCli {
     #[command(subcommand)]
     subcommand: QuerySubCommand,
 }
 
 #[derive(Args, Debug, Clone)]
+/// Arguments for querying prices.
 pub struct QueryArgs {
     /// The list of query ids to query prices for
     pub query_ids: Vec<String>,
@@ -34,50 +55,59 @@ pub struct QueryArgs {
     #[arg(short, long, default_value = DEFAULT_TIMEOUT)]
     pub timeout: HumanDuration,
 }
-
 #[derive(Subcommand, Debug)]
+/// Supported query subcommands for each exchange or data source.
 pub enum QuerySubCommand {
     /// Query Binance prices
+    #[clap(name = "binance")]
     Binance {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query Bitfinex prices
+    #[clap(name = "bitfinex")]
     Bitfinex {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query Bybit prices
+    #[clap(name = "bybit")]
     Bybit {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query Coinbase prices
+    #[clap(name = "coinbase")]
     Coinbase {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query CoinGecko prices
+    #[clap(name = "coingecko")]
     CoinGecko {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query CoinMarketCap prices
+    #[clap(name = "coinmarketcap")]
     CoinMarketCap {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query HTX prices
+    #[clap(name = "htx")]
     Htx {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query Kraken prices
+    #[clap(name = "kraken")]
     Kraken {
         #[clap(flatten)]
         args: QueryArgs,
     },
     /// Query OKX prices
+    #[clap(name = "okx")]
     Okx {
         #[clap(flatten)]
         args: QueryArgs,