From 254b1f2213380806118d40f279e8f7ca2ef3f8de Mon Sep 17 00:00:00 2001 From: Stefan Reiter Date: Thu, 15 Oct 2020 12:49:15 +0200 Subject: [PATCH] rustdoc: add crate level doc Contains a link to the 'backup' module's doc, as that explains a lot about the inner workings of PBS and probably marks a good entry point for new readers. Signed-off-by: Stefan Reiter --- src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index c44c9ae1..cc51b2e0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,8 @@ +//! See the different modules for documentation on their usage. +//! +//! The [backup](backup/index.html) module contains some detailed information +//! on the inner workings of the backup server regarding data storage. + pub mod task; #[macro_use]