docs: add final documentation to lib

Signed-off-by: Gustavo Inacio <[email protected]>

Author: gusinacio

crates/tap-agent/src/lib.rs

@@ -3,13 +3,22 @@
 
 #![warn(missing_docs)] // Warns if any public item lacks documentation
 
+//! # Tap-Agent
+//! This software is used to monitor receipts inserted in the database
+//! and to keep track of all the values across different allocations.
+//!
+//! It's main goal is that the value never goes below the balance available
+//! in the escrow account for a given sender.
+
 use indexer_config::Config;
 use lazy_static::lazy_static;
 use tap_core::tap_eip712_domain;
 use thegraph_core::alloy::sol_types::Eip712Domain;
 
 lazy_static! {
+    /// Static configuration
     pub static ref CONFIG: Config = cli::get_config().expect("Failed to load configuration");
+    /// Static EIP_712_DOMAIN used with config values
     pub static ref EIP_712_DOMAIN: Eip712Domain = tap_eip712_domain(
         CONFIG.blockchain.chain_id as u64,
         CONFIG.blockchain.receipts_verifier_address,
@@ -20,9 +29,12 @@ pub mod adaptative_concurrency;
 pub mod agent;
 pub mod backoff;
 pub mod cli;
+/// Database helper
 pub mod database;
+/// Prometheus Metrics server
 pub mod metrics;
 pub mod tap;
 #[cfg(any(test, feature = "test"))]
+/// Test utils to interact with Tap Actors
 pub mod test;
 pub mod tracker;

crates/tap-agent/src/test.rs

@@ -1,6 +1,7 @@
 // Copyright 2023-, Edge & Node, GraphOps, and Semiotic Labs.
 // SPDX-License-Identifier: Apache-2.0
 
+#![allow(missing_docs)]
 use std::{
     collections::{HashMap, HashSet},
     net::SocketAddr,