Browse Source

docs: Fix broken links (#3482) (#3488)

* 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)
pull/3500/head
Sean Braithwaite 5 years ago
committed by Ismail Khoffi
parent
commit
d586945d69
6 changed files with 9 additions and 8 deletions
  1. +1
    -0
      CHANGELOG_PENDING.md
  2. +1
    -1
      docs/networks/docker-compose.md
  3. +4
    -4
      docs/spec/blockchain/blockchain.md
  4. +1
    -1
      docs/spec/blockchain/encoding.md
  5. +1
    -1
      docs/spec/consensus/abci.md
  6. +1
    -1
      docs/spec/consensus/wal.md

+ 1
- 0
CHANGELOG_PENDING.md View File

@ -26,3 +26,4 @@
### BUG FIXES:
- [blockchain] \#2699 update the maxHeight when a peer is removed
- [docs] \#3482 fix broken links (@brapse)

+ 1
- 1
docs/networks/docker-compose.md View File

@ -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/)


+ 4
- 4
docs/spec/blockchain/blockchain.md View File

@ -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
@ -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
@ -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
@ -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


+ 1
- 1
docs/spec/blockchain/encoding.md View File

@ -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).

+ 1
- 1
docs/spec/consensus/abci.md View File

@ -1 +1 @@
[Moved](/docs/spec/software/abci.md)
[Moved](../software/abci.md)

+ 1
- 1
docs/spec/consensus/wal.md View File

@ -1 +1 @@
[Moved](/docs/spec/software/wal.md)
[Moved](../software/wal.md)

Loading…
Cancel
Save