From 87d4ff74d06e5ca72c79a1ada09083d3347adcca Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Wed, 20 Nov 2024 18:32:58 -0500 Subject: [PATCH] Workflow Fix: markdown-lint (#111) Fixing some errors that still occur in markdown-lint. --- .github/workflows/.markdownlint.json | 7 +------ waku/standards/core/33/discv5.md | 26 ++++++++++++------------- waku/standards/core/34/peer-exchange.md | 6 ++++-- 3 files changed, 18 insertions(+), 21 deletions(-) diff --git a/.github/workflows/.markdownlint.json b/.github/workflows/.markdownlint.json index 3280b7c8..472afbbb 100644 --- a/.github/workflows/.markdownlint.json +++ b/.github/workflows/.markdownlint.json @@ -1,9 +1,4 @@ { - "MD013": { - "tables": false, - "code_blocks" : false, - "line_length" : false - } - + "MD013": false, "MD024": false } diff --git a/waku/standards/core/33/discv5.md b/waku/standards/core/33/discv5.md index dca0557b..d4f48a82 100644 --- a/waku/standards/core/33/discv5.md +++ b/waku/standards/core/33/discv5.md @@ -206,19 +206,19 @@ raises research questions that we will address in future stages of our discv5 ro 1. [10/WAKU2](../10/waku2.md) 2. [`34/WAKU2-PEER-EXCHANGE`](/waku/standards/core/34/peer-exchange.md) -1. [11/WAKU2-RELAY](../11/relay.md) -1. [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md) -1. [Node Discovery Protocol v5 (`discv5`)](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md) -1. [`discv5` semantics](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md). -1. [`discv5` wire protocol](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md) -1. [`discv5` topic discovery](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md#topic-advertisement) -1. [libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md) -1. [`EIP-1459`](https://eips.ethereum.org/EIPS/eip-1459) -1. [`GossipSub`](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md) -1. [Waku discv5 roadmap discussion](https://forum.vac.dev/t/waku-v2-discv5-roadmap-discussion/121) -1. [discovery efficiency estimation](https://forum.vac.dev/t/waku-v2-discv5-roadmap-discussion/121/8) -1. [implementation: Nim](https://github.com/kaiserd/nim-eth/blob/add-selectable-protocol-id-static/eth/p2p/discoveryv5/encoding.nim) -1. [implementation: Go](https://github.com/status-im/go-waku/blob/master/waku/v2/discv5/discover.go) +3. [11/WAKU2-RELAY](../11/relay.md) +4. [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md) +5. [Node Discovery Protocol v5 (`discv5`)](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md) +6. [`discv5` semantics](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md). +7. [`discv5` wire protocol](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md) +8. [`discv5` topic discovery](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md#topic-advertisement) +9. [libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md) +10. [`EIP-1459`](https://eips.ethereum.org/EIPS/eip-1459) +11. [`GossipSub`](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md) +12. [Waku discv5 roadmap discussion](https://forum.vac.dev/t/waku-v2-discv5-roadmap-discussion/121) +13. [discovery efficiency estimation](https://forum.vac.dev/t/waku-v2-discv5-roadmap-discussion/121/8) +14. [implementation: Nim](https://github.com/kaiserd/nim-eth/blob/add-selectable-protocol-id-static/eth/p2p/discoveryv5/encoding.nim) +15. [implementation: Go](https://github.com/status-im/go-waku/blob/master/waku/v2/discv5/discover.go) ## Copyright diff --git a/waku/standards/core/34/peer-exchange.md b/waku/standards/core/34/peer-exchange.md index 5b0262a4..9c00c9b9 100644 --- a/waku/standards/core/34/peer-exchange.md +++ b/waku/standards/core/34/peer-exchange.md @@ -43,6 +43,7 @@ which is explained in the This protocol SHOULD only be used if [33/WAKU2-DISCV5](/waku/standards/core/33/discv5.md) is infeasible. ## Theory and Protocol Semantics + The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt). @@ -125,8 +126,9 @@ containing a list of `PeerInfo` instances, which in turn hold an ENR. ### Discovery Interface Implementations can implement the libp2p discovery interface: -- [nim](https://github.com/status-im/nim-libp2p/issues/140) -- [javascript](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interface-peer-discovery). + +* [nim](https://github.com/status-im/nim-libp2p/issues/140) +* [javascript](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interface-peer-discovery). ### Exchange Peer Cache Size