Skip to content

Commit

Permalink
Merge pull request #81 from tendermint/callum/markdown-link-checker
Browse files Browse the repository at this point in the history
Add markdown link checker
  • Loading branch information
cmwaters committed Mar 10, 2020
2 parents 327767a + 3f04e8b commit 9440fc1
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 12 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Check Markdown links

on: push

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@0.6.0
2 changes: 1 addition & 1 deletion spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ please submit them to our [bug bounty](https://tendermint.com/security)!
- [Consensus Algorithm](./consensus/consensus.md)
- [Creating a proposal](./consensus/creating-proposal.md)
- [Time](./consensus/bft-time.md)
- [Light-Client](./consensus/light-client.md)
- [Light-Client](./consensus/light-client/README.md)

### P2P and Network Protocols

Expand Down
3 changes: 0 additions & 3 deletions spec/consensus/fork-accountability.md

This file was deleted.

3 changes: 0 additions & 3 deletions spec/consensus/light-client.md

This file was deleted.

2 changes: 1 addition & 1 deletion spec/consensus/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Specification of the Tendermint consensus protocol.
consensus state machine to recover from crashes.

The protocol used to gossip consensus messages between peers, which is critical
for liveness, is described in the [reactors section](/spec/reactors/consensus).
for liveness, is described in the [reactors section](../reactors/consensus/consensus.md).

There is also a [stale markdown description](consensus.md) of the consensus state machine
(TODO update this).
3 changes: 2 additions & 1 deletion spec/p2p/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Seeds should operate full nodes with the PEX reactor in a "crawler" mode
that continuously explores to validate the availability of peers.

Seeds should only respond with some top percentile of the best peers it knows about.
See [the peer-exchange docs](https://github.com/tendermint/tendermint/blob/master/docs/spec/reactors/pex/pex.md)for details on peer quality.
See [the peer-exchange docs](https://github.com/tendermint/spec/blob/master/spec/reactors/pex/pex.md) for
details on peer quality.

## New Full Node

Expand Down
7 changes: 5 additions & 2 deletions spec/reactors/consensus/consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ explained in a forthcoming document.
For efficiency reasons, validators in Tendermint consensus protocol do not agree directly on the
block as the block size is big, i.e., they don't embed the block inside `Proposal` and
`VoteMessage`. Instead, they reach agreement on the `BlockID` (see `BlockID` definition in
[Blockchain](https://github.com/tendermint/tendermint/blob/master/docs/spec/blockchain/blockchain.md#blockid) section) that uniquely identifies each block. The block itself is
[Blockchain](https://github.com/tendermint/spec/blob/master/spec/blockchain/blockchain.md#blockid) section)
that uniquely identifies each block. The block itself is
disseminated to validator processes using peer-to-peer gossiping protocol. It starts by having a
proposer first splitting a block into a number of block parts, that are then gossiped between
processes using `BlockPartMessage`.
Expand Down Expand Up @@ -65,7 +66,9 @@ type Proposal struct {
## VoteMessage

VoteMessage is sent to vote for some block (or to inform others that a process does not vote in the
current round). Vote is defined in the [Blockchain](https://github.com/tendermint/tendermint/blob/master/docs/spec/blockchain/blockchain.md#blockid) section and contains validator's
current round). Vote is defined in the
[Blockchain](https://github.com/tendermint/spec/blob/master/spec/blockchain/blockchain.md#blockidd)
section and contains validator's
information (validator address and index), height and round for which the vote is sent, vote type,
blockID if process vote for some block (`nil` otherwise) and a timestamp when the vote is sent. The
message is signed by the validator private key.
Expand Down
2 changes: 1 addition & 1 deletion spec/reactors/mempool/reactor.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ See [this issue](https://github.com/tendermint/tendermint/issues/1503)
Mempool maintains a cache of the last 10000 transactions to prevent
replaying old transactions (plus transactions coming from other
validators, who are continually exchanging transactions). Read [Replay
Protection](../../../app-dev/app-development.md#replay-protection)
Protection](https://github.com/tendermint/tendermint/blob/master/docs/app-dev/app-development.md#replay-protection)
for details.

Sending incorrectly encoded data or data exceeding `maxMsgSize` will result
Expand Down

0 comments on commit 9440fc1

Please sign in to comment.