Skip to content

Commit

Permalink
docs: Fix broken links (#3482) (#3488)
Browse files Browse the repository at this point in the history
* docs: fix broken links (#3482)

A bunch of links were broken in the documentation s they included the
`docs` prefix.

* Update CHANGELOG_PENDING

* docs: switch to relative links for github compatitibility (#3482)
  • Loading branch information
brapse authored and liamsi committed Mar 27, 2019
1 parent ae88965 commit 6a45379
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/networks/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With Docker Compose, you can spin up local testnets with a single command.

## Requirements

1. [Install tendermint](/docs/introduction/install.md)
1. [Install tendermint](../introduction/install.md)
2. [Install docker](https://docs.docker.com/engine/installation/)
3. [Install docker-compose](https://docs.docker.com/compose/install/)

Expand Down
8 changes: 4 additions & 4 deletions docs/spec/blockchain/blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ type PartSetHeader struct {
}
```
See [MerkleRoot](/docs/spec/blockchain/encoding.md#MerkleRoot) for details.
See [MerkleRoot](./encoding.md#MerkleRoot) for details.
## Time
Expand Down Expand Up @@ -163,7 +163,7 @@ a _precommit_ has `vote.Type == 2`.
Signatures in Tendermint are raw bytes representing the underlying signature.
See the [signature spec](/docs/spec/blockchain/encoding.md#key-types) for more.
See the [signature spec](./encoding.md#key-types) for more.
## EvidenceData
Expand All @@ -190,7 +190,7 @@ type DuplicateVoteEvidence struct {
}
```
See the [pubkey spec](/docs/spec/blockchain/encoding.md#key-types) for more.
See the [pubkey spec](./encoding.md#key-types) for more.
## Validation
Expand All @@ -209,7 +209,7 @@ the current version of the `state` corresponds to the state
after executing transactions from the `prevBlock`.
Elements of an object are accessed as expected,
ie. `block.Header`.
See the [definition of `State`](/docs/spec/blockchain/state.md).
See the [definition of `State`](./state.md).
### Header
Expand Down
2 changes: 1 addition & 1 deletion docs/spec/blockchain/encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,6 @@ type CanonicalVote struct {

The field ordering and the fixed sized encoding for the first three fields is optimized to ease parsing of SignBytes
in HSMs. It creates fixed offsets for relevant fields that need to be read in this context.
For more details, see the [signing spec](/docs/spec/consensus/signing.md).
For more details, see the [signing spec](../consensus/signing.md).
Also, see the motivating discussion in
[#1622](https://github.com/tendermint/tendermint/issues/1622).
2 changes: 1 addition & 1 deletion docs/spec/consensus/abci.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[Moved](/docs/spec/software/abci.md)
[Moved](../software/abci.md)
2 changes: 1 addition & 1 deletion docs/spec/consensus/wal.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[Moved](/docs/spec/software/wal.md)
[Moved](../software/wal.md)

0 comments on commit 6a45379

Please sign in to comment.