Merge pull request #1364 from jpraynaud/jpraynaud/fix-relay-doc

Author: jpraynaud

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-relay"
-version = "0.1.0"
+version = "0.1.1"
 description = "A Mithril relay"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-relay/Cargo.toml

@@ -1,6 +1,5 @@
 #![warn(missing_docs)]
-
-//! Mithril relay modules
+#![doc = include_str!("../README.md")]
 
 mod commands;
 /// Peer to peer module

mithril-relay/src/lib.rs

@@ -1,6 +1,6 @@
 use thiserror::Error;
 
-/// [EraMarkersPayload] related errors.
+/// [Peer] related errors.
 #[derive(Debug, Error)]
 pub enum PeerError {
     /// Topic does not exist

mithril-relay/src/p2p/error.rs

@@ -14,14 +14,14 @@ use std::{collections::HashMap, time::Duration};
 
 use crate::{p2p::PeerError, MITHRIL_SIGNATURES_TOPIC_NAME};
 
-/// Custom network behaviour
+/// [Peer] custom network behaviour
 #[derive(NetworkBehaviour)]
 pub struct PeerBehaviour {
     gossipsub: gossipsub::Behaviour,
     ping: ping::Behaviour,
 }
 
-/// Peer event that is polled from the swarm
+/// [Peer] event that is polled from the swarm
 #[derive(Debug)]
 pub enum PeerEvent {
     /// The peer is listening on an address