feat(derive): sources docs (#754)

op-rs · Oct 30, 2024 · 9621797 · 9621797
1 parent 13d7e82
commit 9621797
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/crates/derive/src/sources/mod.rs b/crates/derive/src/sources/mod.rs
@@ -1,4 +1,11 @@
-//! This module contains data source impelmentations.
+//! The data source module.
+//!
+//! Data sources are data providers for the kona derivation pipeline.
+//! They implement the [DataAvailabilityProvider] trait, providing a way
+//! to iterate over data for a given (L2) [BlockInfo].
+//!
+//! [DataAvailabilityProvider]: crate::traits::DataAvailabilityProvider
+//! [BlockInfo]: op_alloy_protocol::BlockInfo
 
 mod ethereum;
 pub use ethereum::EthereumDataSource;