feat: table dashboard (#1003)

* feat: table dashboard

* fix: implement feedback

* fix: add values from the google sheet

* fix: move sdr up one level

* fix: add docs about props

* fix: tweak docs

README.md

@@ -126,15 +126,28 @@ Some text
 ```
 
 ## Frontmatter
+
+Description for all the available frontmatter properties
+
 ```md
-title: Libraries
+<!-- Page Title to be used in the navigation -->
+title: Libraries 
+<!-- Small description for html metadata, if not present the first couple of paragraphs will be used instead -->
 description: Libraries used from Filecoin
+<!-- This will be used to order the navigation and any other listing of pages -->
 weight: 3
+<!-- This will make a page section collapse in the navigation -->
 bookCollapseSection: true
+<!-- This will hidden the page from the navigation -->
 bookhidden: true
+<!-- This is used in the dashboard to describe the importance of the page content -->
+dashboardWeight: 2
+<!-- This is used in the dashboard to describe the state of the page content options are "incorrect", "wip", "incomplete" and "stable" -->
+dashboardState: stable
+<!-- This is used in the dashboard to describe if the theory of the page has been audited, options are 1 or 0 -->
 dashboardAudit: 1
-dashboardState: wip
-dashboardInterface: stable
+<!-- This is used in the dashboard to describe if the page content has compliance tests, options are 0 or numbers of tests -->
+dashboardTests: 0
 ```
 
 ## Code fences

assets/_colors.scss

@@ -0,0 +1,15 @@
+// Colors
+.text-incorrect {color: #ff0010;}
+.text-wip {color: #ff6f00;}
+.text-incomplete {color: #ffef00;}
+.text-stable {color: #90ff00;}
+.text-transparent { color: transparent;}
+.text-black { color: black;}
+
+.bg-na { background-color: #6c8293;}
+.bg-incorrect {background-color: #ff0010;}
+.bg-wip {background-color: #ff6f00;}
+.bg-incomplete {background-color: #ffef00;}
+.bg-stable {background-color: #90ff00;}
+.bg-transparent { background-color: transparent;}
+.bg-black { background-color: black;}

assets/_custom.scss

@@ -4,6 +4,9 @@
 
 // @import "plugins/numbered";
 @import "plugins/scrollbars";
+@import "table-sort";
+@import "colors";
+@import "dashboard";
 
 // SVG Diagrams
 .diagrams-container {
@@ -184,27 +187,6 @@ h5 {
   color: rgba(255,255,255,0.87)
 }
 
-// Colors
-.color-incorrect {
-    color: #BF616A;
-}
-
-.color-wip {
-    color: #D08770;
-}
-
-.color-incomplete {
-    color: #EBCB8B;
-}
-
-.color-stable {
-    color: #5E81AC;
-}
-
-.color-permanent {
-    color: #A3BE8C;
-}
-
 i[class^="gg-"] {
     display: inline-block;
     margin-left: 3px;

assets/_dashboard.scss

@@ -0,0 +1,17 @@
+.Dashboard tr th,
+.Dashboard tr td {
+    padding: 0 1rem !important;
+    font-size: 12px;
+    text-align: center;
+}
+.Dashboard tr td:first-child {
+    text-align: left;
+}
+
+.Dashboard-section {
+    max-width:250px;
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+

assets/_table-sort.scss

@@ -0,0 +1,37 @@
+th[role=columnheader]:not(.no-sort) {
+    cursor: pointer;
+    position: relative;
+    min-width: 110px;
+}
+
+th[role=columnheader]:not(.no-sort):after {
+	content: '';
+	position: absolute;
+    top: -3px;
+    right: 10px;
+	margin-top: 10px;
+	border-width: 0 4px 4px;
+	border-style: solid;
+	border-color: #404040 transparent;
+	visibility: hidden;
+	opacity: 0;
+	-ms-user-select: none;
+	-webkit-user-select: none;
+	-moz-user-select: none;
+	user-select: none;
+}
+
+th[aria-sort=ascending]:not(.no-sort):after {
+	border-bottom: none;
+	border-width: 4px 4px 0;
+}
+
+th[aria-sort]:not(.no-sort):after {
+	visibility: visible;
+	opacity: 0.4;
+}
+
+th[role=columnheader]:not(.no-sort):hover:after {
+	visibility: visible;
+	opacity: 1;
+}

content/algorithms/_index.md

@@ -1,7 +1,10 @@
 ---
 title: Algorithms
 bookCollapseSection: true
-dashboardState: incorrect
-type: docs
 weight: 4
+
+dashboardWeight: 2
+dashboardState: wip
+dashboardAudit: 0
+dashboardTests: 0
 ---

content/algorithms/block_sync.md

@@ -1,6 +1,10 @@
 ---
 title: "BlockSync"
 weight: 5
+dashboardWeight: 1
+dashboardState: wip
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # BlockSync

content/algorithms/crypto/_index.md

@@ -2,10 +2,10 @@
 title: "Cryptographic Primitives"
 bookCollapseSection: true
 weight: 7
-entries:
-  - signatures
-  - vrf
-  - randomness
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Cryptographic Primitives

content/algorithms/crypto/randomness.md

@@ -1,6 +1,10 @@
 ---
 title: "Randomness"
 weight: 3
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Randomness

content/algorithms/crypto/signatures.md

@@ -1,6 +1,10 @@
 ---
 title: "Signatures"
 weight: 1
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Signatures

content/algorithms/crypto/vrf.md

@@ -1,6 +1,10 @@
 ---
 title: "Verifiable Random Function"
 weight: 2
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Verifiable Random Function

content/algorithms/cryptoecon/_index.md

@@ -1,6 +1,10 @@
 ---
 title: Cryptoecon
 weight: 8
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Cryptoecon

content/algorithms/expected_consensus/_index.md

@@ -1,6 +1,10 @@
 ---
 title: "Expected Consensus"
 weight: 1
+dashboardWeight: 2
+dashboardState: incomplete
+dashboardAudit: 1
+dashboardTests: 0
 ---
 
 # Expected Consensus

content/algorithms/gossip_sub.md

@@ -1,6 +1,10 @@
 ---
 title: "GossipSub"
 weight: 6
+dashboardWeight: 1.5
+dashboardState: incomplete
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # GossipSub

content/algorithms/payment_channels.md

@@ -1,6 +1,10 @@
 ---
 title: "Payment Channels"
 weight: 4
+dashboardWeight: 1
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Payment Channels

content/algorithms/post/_index.md

@@ -2,6 +2,10 @@
 title: Proof-of-Spacetime
 bookCollapseSection: true
 weight: 3
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Proof-of-Spacetime

content/algorithms/post/election_post.md

@@ -1,5 +1,9 @@
 ---
 title: Election PoSt
+dashboardWeight: 2
+dashboardState: incorrect
+dashboardAudit: 0
+dashboardTests: 0
 ---
 
 # Election PoSt

content/algorithms/post/proof_of_spacetime_parameters.org

@@ -1,6 +1,10 @@
 #+TITLE: PoSt Parameters
 #+HUGO_SECTION: algorithms/post
 #+HUGO_BASE_DIR: ../../
+#+dashboardWeight: 2
+#+dashboardState: incorrect
+#+dashboardAudit: 0
+#+dashboardTests: 0
 
 * Proof of Spacetime Paramerters