From 6fc35a2d7ed95232e4e9912b3c9bfc4b0785bdab Mon Sep 17 00:00:00 2001 From: Prithvi Shahi <50885601+p-shahi@users.noreply.github.com> Date: Mon, 15 May 2023 09:11:41 -0700 Subject: [PATCH] chore: add spec links (#173) Signed-off-by: Dave Huseby Co-authored-by: Dave Huseby --- data/implementations/crypto_channels.json | 6 ++++-- data/implementations/discovery.json | 9 ++++++--- data/implementations/nat_traversal.json | 12 ++++++++---- data/implementations/others.json | 3 ++- data/implementations/peer_routing.json | 3 ++- data/implementations/stream_muxers.json | 6 ++++-- data/implementations/transports.json | 12 ++++++++---- data/implementations/utils.json | 3 ++- layouts/partials/implementation.html | 14 ++++++++++---- less/implementations.less | 7 ++++--- 10 files changed, 50 insertions(+), 25 deletions(-) diff --git a/data/implementations/crypto_channels.json b/data/implementations/crypto_channels.json index bc5e8c3..b2f3b20 100644 --- a/data/implementations/crypto_channels.json +++ b/data/implementations/crypto_channels.json @@ -3,7 +3,8 @@ "title": "Secure Communication", "libs": [ { - "id": "libp2p-noise", + "id": "libp2p-noise 🔗", + "url": "https://github.com/libp2p/specs/blob/master/noise/", "langs": { "Go": { "status": "Done", @@ -43,7 +44,8 @@ } }, { - "id": "libp2p-tls", + "id": "libp2p-tls 🔗", + "url": "https://github.com/libp2p/specs/blob/master/tls/tls.md", "langs": { "Go": { "status": "Done", diff --git a/data/implementations/discovery.json b/data/implementations/discovery.json index bf5915c..2e18079 100644 --- a/data/implementations/discovery.json +++ b/data/implementations/discovery.json @@ -3,7 +3,8 @@ "title": "Discovery", "libs": [ { - "id": "bootstrap", + "id": "bootstrap 🔗", + "url": "https://github.com/libp2p/specs/blob/master/kad-dht/README.md#bootstrap-process", "langs": { "Go": { "status": "Done", @@ -74,7 +75,8 @@ } }, { - "id": "mdns-discovery", + "id": "mdns-discovery 🔗", + "url": "https://github.com/libp2p/specs/blob/master/discovery/mdns.md", "langs": { "Go": { "status": "Done", @@ -110,7 +112,8 @@ } }, { - "id": "rendezvous", + "id": "rendezvous 🔗", + "url": "https://github.com/libp2p/specs/blob/master/rendezvous/README.md", "langs": { "Go": { "status": "Missing" diff --git a/data/implementations/nat_traversal.json b/data/implementations/nat_traversal.json index b81138f..31de5ca 100644 --- a/data/implementations/nat_traversal.json +++ b/data/implementations/nat_traversal.json @@ -3,7 +3,8 @@ "title": "NAT Traversal", "libs": [ { - "id": "libp2p-circuit-relay-v1", + "id": "libp2p-circuit-relay-v1 🔗", + "url": "https://github.com/libp2p/specs/blob/master/relay/circuit-v1.md", "langs": { "Go": { "status": "Done", @@ -38,7 +39,8 @@ } }, { - "id": "libp2p-circuit-relay-v2", + "id": "libp2p-circuit-relay-v2 🔗", + "url": "https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md", "langs": { "Go": { "status": "Done", @@ -74,7 +76,8 @@ } }, { - "id": "libp2p-autonat", + "id": "libp2p-autonat 🔗", + "url": "https://github.com/libp2p/specs/tree/master/autonat", "langs": { "Go": { "status": "Done", @@ -112,7 +115,8 @@ } }, { - "id": "libp2p-hole-punching", + "id": "libp2p-hole-punching 🔗", + "url": "https://github.com/libp2p/specs/blob/master/connections/hole-punching.md", "langs": { "Go": { "status": "Done", diff --git a/data/implementations/others.json b/data/implementations/others.json index 27634ee..c8f1568 100644 --- a/data/implementations/others.json +++ b/data/implementations/others.json @@ -42,7 +42,8 @@ } }, { - "id": "libp2p-gossipsub", + "id": "libp2p-gossipsub 🔗", + "url": "https://github.com/libp2p/specs/tree/master/pubsub/gossipsub", "langs": { "Go": { "status": "Done", diff --git a/data/implementations/peer_routing.json b/data/implementations/peer_routing.json index 355341d..677197b 100644 --- a/data/implementations/peer_routing.json +++ b/data/implementations/peer_routing.json @@ -3,7 +3,8 @@ "title": "Peer Routing", "libs": [ { - "id": "libp2p-kad-dht", + "id": "libp2p-kad-dht 🔗", + "url": "https://github.com/libp2p/specs/blob/master/kad-dht/README.md", "langs": { "Go": { "status": "Done", diff --git a/data/implementations/stream_muxers.json b/data/implementations/stream_muxers.json index 3121479..16f9407 100644 --- a/data/implementations/stream_muxers.json +++ b/data/implementations/stream_muxers.json @@ -3,7 +3,8 @@ "title": "Stream Multiplexing", "libs": [ { - "id": "libp2p-yamux", + "id": "libp2p-yamux 🔗", + "url": "https://github.com/libp2p/specs/blob/master/yamux/README.md", "langs": { "Go": { "status": "Done", @@ -41,7 +42,8 @@ } }, { - "id": "libp2p-mplex", + "id": "libp2p-mplex 🔗", + "url": "https://github.com/libp2p/specs/blob/master/mplex/README.md", "langs": { "Go": { "status": "Done", diff --git a/data/implementations/transports.json b/data/implementations/transports.json index b2d2197..5ffa9c8 100644 --- a/data/implementations/transports.json +++ b/data/implementations/transports.json @@ -44,7 +44,8 @@ } }, { - "id": "libp2p-quic", + "id": "libp2p-quic 🔗", + "url": "https://github.com/libp2p/specs/tree/master/quic", "langs": { "Go": { "status": "Done", @@ -117,7 +118,8 @@ } }, { - "id": "libp2p-webtransport", + "id": "libp2p-webtransport 🔗", + "url": "https://github.com/libp2p/specs/tree/master/webtransport", "langs": { "Go": { "status": "Done", @@ -151,7 +153,8 @@ } }, { - "id": "libp2p-webrtc-browser-to-server", + "id": "libp2p-webrtc-browser-to-server 🔗", + "url": "https://github.com/libp2p/specs/blob/master/webrtc/webrtc-direct.md", "langs": { "Go": { "status": "Unstable", @@ -219,7 +222,8 @@ } }, { - "id": "libp2p-webrtc-private-to-private", + "id": "libp2p-webrtc-private-to-private 🔗", + "url": "https://github.com/libp2p/specs/blob/master/webrtc/webrtc.md", "langs": { "Go": { "status": "Missing" diff --git a/data/implementations/utils.json b/data/implementations/utils.json index 5c2827e..7f9cc80 100644 --- a/data/implementations/utils.json +++ b/data/implementations/utils.json @@ -43,7 +43,8 @@ } }, { - "id": "libp2p-ping", + "id": "libp2p-ping 🔗", + "url": "https://github.com/libp2p/specs/blob/master/ping/ping.md", "langs": { "Go": { "status": "Done", diff --git a/layouts/partials/implementation.html b/layouts/partials/implementation.html index 5e2caf4..979b819 100644 --- a/layouts/partials/implementation.html +++ b/layouts/partials/implementation.html @@ -25,15 +25,21 @@ {{ range $lib := .libs }} - {{ .id }} + + {{ if .url }} + {{ .id }} + {{ else }} + {{ .id }} + {{ end }} + {{ range $impl := $impls }} - {{ with index $lib.langs $impl }} + {{ with index $lib.langs $impl }} {{ partial "status-icon.html" . }} - {{ else }} - Missing! + {{ else }} + Missing! {{ end }} {{ end }} diff --git a/less/implementations.less b/less/implementations.less index 67fdd2a..f638f32 100755 --- a/less/implementations.less +++ b/less/implementations.less @@ -543,19 +543,20 @@ article.implementations-info { } } - th { + th, th > a { font-family: Roboto-Light, SansSerif; color: #A9B0BC; border-right: 1px solid #DFE5EE; width: 99px; text-align: left; padding-left: 40px; + text-decoration: none; @media (max-width: 940px) { padding-left: 17px; } - &.head-col { + &.head-col, &.head-col > a { position: absolute; left: 0; top: auto; @@ -590,7 +591,7 @@ article.implementations-info { &:not(.empty):not(.head-row):hover { - th { + th, th > a { color: #21B7EC; } td {