From ef253b7b87c498f96da9e2033c2ac5c515e6692f Mon Sep 17 00:00:00 2001
From: rand00 <oth.rand@gmail.com>
Date: Tue, 29 Mar 2022 12:56:11 +0200
Subject: [PATCH] Views: Added usage-descriptions on mouse-over on '?' below
 each visualzation (not mobile compatible)

---
 lib/views.ml | 81 ++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 63 insertions(+), 18 deletions(-)

diff --git a/lib/views.ml b/lib/views.ml
index 4810936..28f42ed 100644
--- a/lib/views.ml
+++ b/lib/views.ml
@@ -635,29 +635,74 @@ module Job_build = struct
       min-height: 43em;
     "
 
+  let make_description descr_txt =
+    H.span [ H.txt "?" ] ~a:H.[
+        a_title descr_txt;
+        a_style "\
+          font-size: 1.2em;\
+          font-weight: bold;\
+          "
+      ]
+  
   let make_viz_section ~name ~artifacts ~uuid =
-    let viz_deps_iframe = [
-      let src = Fmt.str "/job/%s/build/%a/vizdependencies" name Uuidm.pp uuid in
-      H.iframe ~a:H.[
-          a_src src;
-          a_title "Opam dependencies";
-          a_style viz_style_deps
-        ] []
-    ]
+    let viz_deps = 
+      let iframe = 
+        let src = Fmt.str "/job/%s/build/%a/vizdependencies" name Uuidm.pp uuid in
+        H.iframe ~a:H.[
+            a_src src;
+            a_title "Opam dependencies";
+            a_style viz_style_deps
+          ] []
+      in
+      let descr_txt = "\
+This is an interactive visualization of dependencies, \
+focusing on how shared dependencies are. 
+
+In the middle you see the primary package. \
+Edges shoot out to its direct \
+dependencies, including build dependencies. 
+
+From these direct dependencies, edges shoot out to sets \
+of their own respective direct dependencies. \
+These dependency-sets include duplicates (i.e. shared dependencies) \
+across the other dependency sets \
+- which are shown by hovering over the \
+direct dependencies of the primary package.
+
+The lightness of nodes correspond to how shared they are. See \
+the exact amount of reverse dependencies in the tooltip for each \
+dependency.\
+"
+      in
+      [ iframe; H.br (); make_description descr_txt ]
     in
-    let viz_treemap_iframe = lazy [
-      let src = Fmt.str "/job/%s/build/%a/viztreemap" name Uuidm.pp uuid in
-      H.iframe ~a:H.[
-          a_src src;
-          a_title "Binary dissection";
-          a_style viz_style_treemap
-        ] []
-    ]
+    let viz_treemap = lazy (
+      let iframe = 
+        let src = Fmt.str "/job/%s/build/%a/viztreemap" name Uuidm.pp uuid in
+        H.iframe ~a:H.[
+            a_src src;
+            a_title "Binary dissection";
+            a_style viz_style_treemap
+          ] []
+      in
+      let descr_txt = "\
+This interactive treemap shows the space-usage of modules/libraries inside the \
+ELF binary. You can get more info from each block by \
+hovering over them. 
+
+On top of the treemap there is a scale, showing how much space the \
+treemap itself constitutes of the binary, the excluded symbols/modules \
+and the rest of the unaccounted data.\
+"
+      in
+      [ iframe; H.br (); make_description descr_txt ]
+    )
     in
+    let a_paragraph = H.[ a_style "text-align: center" ] in
     List.flatten [
-      [ H.p viz_deps_iframe];
+      [ H.p ~a:a_paragraph viz_deps];
       if not @@ contains_debug_bin artifacts then [] else [
-        H.p @@ Lazy.force viz_treemap_iframe ];
+        H.p ~a:a_paragraph @@ Lazy.force viz_treemap ];
     ]
 
   let make