From aa33a7352b4c5d380989c7c6f21680cd245f6363 Mon Sep 17 00:00:00 2001
From: Daniel Sanchez Quiros <sanchez.quiros.daniel@gmail.com>
Date: Fri, 7 Oct 2022 12:39:09 +0200
Subject: [PATCH] Docs modules titles and links

---
 waku/src/events/mod.rs      | 2 ++
 waku/src/general/mod.rs     | 2 ++
 waku/src/node/config.rs     | 2 ++
 waku/src/node/filter.rs     | 2 ++
 waku/src/node/lightpush.rs  | 2 ++
 waku/src/node/management.rs | 2 ++
 waku/src/node/mod.rs        | 2 ++
 waku/src/node/peers.rs      | 2 ++
 waku/src/node/relay.rs      | 2 ++
 waku/src/node/store.rs      | 2 ++
 10 files changed, 20 insertions(+)

diff --git a/waku/src/events/mod.rs b/waku/src/events/mod.rs
index 89f5d72..68d8a28 100644
--- a/waku/src/events/mod.rs
+++ b/waku/src/events/mod.rs
@@ -1,3 +1,5 @@
+//! Waku message [event](https://rfc.vac.dev/spec/36/#events) related items
+//!
 //! Asynchronous events require a callback to be registered.
 //! An example of an asynchronous event that might be emitted is receiving a message.
 //! When an event is emitted, this callback will be triggered receiving a [`Signal`]
diff --git a/waku/src/general/mod.rs b/waku/src/general/mod.rs
index 81b8d57..ffa3c70 100644
--- a/waku/src/general/mod.rs
+++ b/waku/src/general/mod.rs
@@ -1,3 +1,5 @@
+//! Waku [general](https://rfc.vac.dev/spec/36/#general) types
+
 // std
 use std::fmt::{Display, Formatter};
 use std::str::FromStr;
diff --git a/waku/src/node/config.rs b/waku/src/node/config.rs
index 4f8db6c..44d9705 100644
--- a/waku/src/node/config.rs
+++ b/waku/src/node/config.rs
@@ -1,3 +1,5 @@
+//! Waku node [configuration](https://rfc.vac.dev/spec/36/#jsonconfig-type) related items
+
 // std
 // crates
 use libsecp256k1::SecretKey;
diff --git a/waku/src/node/filter.rs b/waku/src/node/filter.rs
index c9562e2..e4ccedb 100644
--- a/waku/src/node/filter.rs
+++ b/waku/src/node/filter.rs
@@ -1,3 +1,5 @@
+//! Waku [filter](https://rfc.vac.dev/spec/36/#waku-filter) protocol related methods
+
 // std
 use std::ffi::{CStr, CString};
 use std::time::Duration;
diff --git a/waku/src/node/lightpush.rs b/waku/src/node/lightpush.rs
index 7a891a4..34ad952 100644
--- a/waku/src/node/lightpush.rs
+++ b/waku/src/node/lightpush.rs
@@ -1,3 +1,5 @@
+//! Waku [lightpush](https://rfc.vac.dev/spec/36/#waku-lightpush) protocol related methods
+
 // std
 use std::ffi::{CStr, CString};
 use std::time::Duration;
diff --git a/waku/src/node/management.rs b/waku/src/node/management.rs
index cd55c56..b0c2073 100644
--- a/waku/src/node/management.rs
+++ b/waku/src/node/management.rs
@@ -1,3 +1,5 @@
+//! Node lifcycle related methods
+
 // std
 use multiaddr::Multiaddr;
 use std::ffi::{CStr, CString};
diff --git a/waku/src/node/mod.rs b/waku/src/node/mod.rs
index 574160b..217e1f7 100644
--- a/waku/src/node/mod.rs
+++ b/waku/src/node/mod.rs
@@ -1,3 +1,5 @@
+//! Waku node implementation
+
 mod config;
 mod filter;
 mod lightpush;
diff --git a/waku/src/node/peers.rs b/waku/src/node/peers.rs
index 4b1a933..ffa12e2 100644
--- a/waku/src/node/peers.rs
+++ b/waku/src/node/peers.rs
@@ -1,3 +1,5 @@
+//! Waku [peer handling and connection](https://rfc.vac.dev/spec/36/#connecting-to-peers) methods
+
 // std
 use std::ffi::{CStr, CString};
 use std::time::Duration;
diff --git a/waku/src/node/relay.rs b/waku/src/node/relay.rs
index 1a80498..b4abd76 100644
--- a/waku/src/node/relay.rs
+++ b/waku/src/node/relay.rs
@@ -1,3 +1,5 @@
+//! Waku [relay](https://rfc.vac.dev/spec/36/#waku-relay) protocol related methods
+
 // std
 use std::ffi::{CStr, CString};
 use std::time::Duration;
diff --git a/waku/src/node/store.rs b/waku/src/node/store.rs
index 90c5d95..cc39a7d 100644
--- a/waku/src/node/store.rs
+++ b/waku/src/node/store.rs
@@ -1,3 +1,5 @@
+//! Waku [store](https://rfc.vac.dev/spec/36/#waku-store) handling methods
+
 // std
 use std::ffi::{CStr, CString};
 use std::time::Duration;