feat: node types readme (#3)

* feat: node types readme

* fix: lints in node-types

* nit: remove codeowners funny

Author: prestwich

.github/CODEOWNERS

@@ -1,3 +1,2 @@
 * @init4tech/engineering
-.github/workflows @rswanson
-crates/zenith/abi @anna-carroll
+.github/workflows @rswanson

crates/node-types/Cargo.toml

@@ -15,6 +15,5 @@ reth-db.workspace = true
 reth-node-api.workspace = true
 reth-node-ethereum.workspace = true
 reth-trie-db.workspace = true
-reth-prune-types.workspace = true
 
 tokio.workspace = true

crates/node-types/README.md

@@ -0,0 +1,10 @@
+# Signet Node Types
+
+This crate provides parameterizations and conveneniences for the Signet node's
+use of reth's internal generics. E.g. [`NodePrimitives`] and [`NodeTypes`].
+
+It also provides a [`NodeTypesDbTrait`] to aggregate several trait constraints
+on the database type. This is then used in the node and in `signet-db`.
+
+This crate is mostly shims. It is not intended to be used outside of the
+Signet node and `signet-db` crates.

crates/node-types/src/lib.rs

@@ -1,4 +1,16 @@
-//! Types used by the signet node
+#![doc = include_str!("../README.md")]
+#![warn(
+    missing_copy_implementations,
+    missing_debug_implementations,
+    missing_docs,
+    unreachable_pub,
+    clippy::missing_const_for_fn,
+    rustdoc::all
+)]
+#![cfg_attr(not(test), warn(unused_crate_dependencies))]
+#![deny(unused_must_use, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use reth::{
     primitives::EthPrimitives,
     providers::{