Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions .github/workflows/markdown-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@
name: Check Markdown links

on:
# Temporarily disabled job on PRs. Re-enable when docs are fixed.
# pull_request:
# paths:
# - "**.md"
pull_request:
push:
branches:
- master
- dev

permissions:
contents: read

concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

# Branch creation/rename events can refer to the deleted old branch.
env:
GIT_DIFF: ${{ github.event_name == 'push' && github.event.created && 'all' || '' }}
Expand All @@ -23,10 +27,24 @@ jobs:
- uses: technote-space/get-diff-action@v6
if: github.event_name != 'push' || !github.event.created
with:
# book/ links are relative to the staged mdBook tree; the docs
# build checks them.
PATTERNS: |
**/**.md
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
check-modified-files-only: "yes"
config-file: ".md-link-check.json"
!book/**
FORMAT: json
Comment thread
Claudius-Maginificent marked this conversation as resolved.
Resolved
# Also match .github/ and .agents/.
MINIMATCH_OPTION_DOT: true
- name: Check links in changed Markdown files
if: env.GIT_DIFF
run: |
if [ "$GIT_DIFF" = all ]; then
mapfile -t files < <(git ls-files '*.md' ':!:book/**')
else
mapfile -t files < <(jq -r '.[]' <<<"$GIT_DIFF")
fi
if [ "${#files[@]}" -eq 0 ]; then
echo "No changed Markdown files."
exit 0
fi
npx --yes markdown-link-check@3.14.2 --config .md-link-check.json --quiet -- "${files[@]}"
15 changes: 14 additions & 1 deletion .md-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,18 @@
"retryOn429": true,
"retryCount": 5,
"fallbackRetryDelay": "30s",
"aliveStatusCodes": [200, 206, 503]
"aliveStatusCodes": [200, 206, 503, 504],
"ignorePatterns": [
{
"comment": "Cloudflare answers every non-browser client with a 403 challenge.",
"pattern": "^https://(eprint|www)\\.iacr\\.org/"
}
],
Comment thread
Claudius-Maginificent marked this conversation as resolved.
Resolved
"replacementPatterns": [
{
"comment": "prepare-docs.py publishes rpc/openapi/ as api/rpc/ in the docs site.",
"pattern": "^((?:\\.\\./)*)api/rpc/",
"replacement": "$1rpc/openapi/"
}
]
}
2 changes: 1 addition & 1 deletion DOCKER/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DockerHub tags for official releases are [here](https://hub.docker.com/r/dashpay

Official releases can be found [here](https://github.com/dashpay/tenderdash/releases).

The Dockerfile used for all builds can be found [here](https://github.com/dashpay/tenderdash/blob/master/DOCKER/Dockerfile).
The Dockerfile used for all builds can be found [here](Dockerfile).

Respective versioned files can be found at `https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile` (replace the Xs with the version number).

Expand Down
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ proto-doc:
--doc_opt=markdown,api.md \
--doc_out=spec/abci \
tendermint/abci/types.proto
# Types from other packages are not in api.md; link their protos instead.
@perl -pi -e 's{\]\(#tendermint-(types|crypto|version)-\w+\)}{](../../proto/tendermint/$$1/)}g; s{\]\(#google-protobuf-(\w+)\)}{"](https://protobuf.dev/reference/protobuf/google.protobuf/#" . lc($$1) . ")"}ge' spec/abci/api.md

###############################################################################
### Build ABCI ###
Expand Down
2 changes: 1 addition & 1 deletion UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ the compilation tag:

Use `cleveldb` tag instead of `gcc` to compile Tendermint with CLevelDB or
use `make build_c` / `make install_c` (full instructions can be found at
<https://docs.tendermint.com/v0.35/introduction/install.html)
<https://docs.tendermint.com/v0.35/introduction/install.html>)

## v0.31.0

Expand Down
2 changes: 1 addition & 1 deletion crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For any specific algorithm, use its specific module e.g.

## Binary encoding

For Binary encoding, please refer to the [Tendermint encoding specification](https://docs.tendermint.com/master/spec/core/encoding.html).
For Binary encoding, please refer to the [Tendermint encoding specification](../spec/core/encoding.md).

## JSON Encoding

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/adr-079-ed25519-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Ed25519 keys are the only supported key types for Tendermint validators currentl
- This library is implements `ed25519.Verify()` in accordance to zip-215. Tendermint-go will continue to use `crypto/ed25519` for signing and key generation.

- Tendermint-rs would adopt [ed25519-zebra](https://github.com/ZcashFoundation/ed25519-zebra)
- related [issue](https://github.com/informalsystems/tendermint-rs/issues/355)
- related [issue](https://github.com/cometbft/tendermint-rs/issues/355)

Signature verification is one of the major bottlenecks of Tendermint-go, batch verification can not be used unless it has the same consensus rules, ZIP 215 makes verification safe in consensus critical areas.

Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/running-in-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ give you limited number of file descriptors.
If you want to accept greater number of connections, you will need to increase
these limits.

[Sysctls to tune the system to be able to open more connections](https://github.com/satori-com/tcpkali/blob/master/doc/tcpkali.man.md#sysctls-to-tune-the-system-to-be-able-to-open-more-connections)
[Sysctls to tune the system to be able to open more connections](https://web.archive.org/web/2022/https://github.com/satori-com/tcpkali/blob/master/doc/tcpkali.man.md#sysctls-to-tune-the-system-to-be-able-to-open-more-connections)

The process file limits must also be increased, e.g. via `ulimit -n 8192`.

Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The sentry nodes should be able to talk to the entire network hence why `pex=tru

More Information can be found at these links:

- <https://kb.certus.one/>
- <https://web.archive.org/web/2021/https://kb.certus.one/>
- <https://forum.cosmos.network/t/sentry-node-architecture-overview/454>

### Validator keys
Expand Down
2 changes: 1 addition & 1 deletion docs/rfc/rfc-012-custom-indexing.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ something like this (subject to refinement):
[i7247]: https://github.com/tendermint/tendermint/issues/7247
[kv-index]: ../../internal/state/indexer/tx/kv
[postgres]: https://postgresql.org/
[psql]: https://github.com/tendermint/tendermint/blob/master/internal/state/indexer/sink/psql
[psql]: https://github.com/tendermint/tendermint/tree/master/internal/state/indexer/sink/psql
[query]: https://pkg.go.dev/github.com/dashpay/tenderdash/internal/pubsub/query/syntax
[sdk]: https://github.com/cosmos/cosmos-sdk
[tmdb]: https://pkg.go.dev/github.com/cometbft/cometbft-db#DB
2 changes: 1 addition & 1 deletion docs/rfc/rfc-013-abci++.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ Proposed

## References

Reference for IPC delay constants: <http://pages.cs.wisc.edu/~adityav/Evaluation_of_Inter_Process_Communication_Mechanisms.pdf>
Reference for IPC delay constants: <https://web.archive.org/web/2020/http://pages.cs.wisc.edu/~adityav/Evaluation_of_Inter_Process_Communication_Mechanisms.pdf>

### Short list of blocked features / scaling improvements with required ABCI++ Phases

Expand Down
8 changes: 4 additions & 4 deletions docs/rfc/rfc-019-config-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,10 +293,10 @@ balance:
- [ADR 075: RPC Event Subscription Interface][adr075]

[config-pkg]: https://godoc.org/github.com/tendermint/tendermint/config
[confix]: https://github.com/tendermint/tendermint/blob/master/scripts/confix
[condiff]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/condiff
[plan]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/plan.go
[testdata]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/testdata
[confix]: ../../internal/libs/confix
[condiff]: https://github.com/dashpay/tenderdash/tree/6dd4bcc93efa5cdcafe8128502f81851fa574146/scripts/confix/condiff
[plan]: ../../internal/libs/confix/plan.go
[testdata]: ../../internal/libs/confix/testdata
[adr075]: https://github.com/tendermint/tendermint/blob/master/docs/architecture/adr-075-rpc-subscription.md

## Appendix: Research Notes
Expand Down
6 changes: 3 additions & 3 deletions docs/rfc/rfc-021-socket-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,10 +260,10 @@ visual inspection.
- Tenderdash Core (Go): [client][socket-client], [server][socket-server]
- Informal Systems [tendermint-rs](https://github.com/informalsystems/tendermint-rs) (Rust): [client](https://github.com/informalsystems/tendermint-rs/blob/master/abci/src/client.rs), [server](https://github.com/informalsystems/tendermint-rs/blob/master/abci/src/server.rs)
- Tendermint [js-abci](https://github.com/tendermint/js-abci) (JS): [server](https://github.com/tendermint/js-abci/blob/master/src/server.js)
- [Hotmoka](https://github.com/Hotmoka/hotmoka) ABCI (Java): [server](https://github.com/Hotmoka/hotmoka/blob/master/io-hotmoka-tendermint-abci/src/main/java/io/hotmoka/tendermint_abci/Server.java)
- [Tower ABCI](https://github.com/penumbra-zone/tower-abci) (Rust): [server](https://github.com/penumbra-zone/tower-abci/blob/main/src/server.rs)
- [Hotmoka](https://github.com/Hotmoka/hotmoka) ABCI (Java): [server](https://github.com/Hotmoka/hotmoka/blob/master/io-hotmoka-node-tendermint-abci/src/main/java/io/hotmoka/tendermint/abci/Server.java)
- [Tower ABCI](https://github.com/penumbra-zone/tower-abci) (Rust): [server](https://github.com/penumbra-zone/tower-abci/blob/v0.5.0/src/server.rs)
- [abci-host](https://github.com/datopia/abci-host) (Clojure): [server](https://github.com/datopia/abci-host/blob/master/src/abci/host.clj)
- [abci_server](https://github.com/KrzysiekJ/abci_server) (Erlang): [server](https://github.com/KrzysiekJ/abci_server/blob/master/src/abci_server.erl)
- [py-abci](https://github.com/davebryson/py-abci) (Python): [server](https://github.com/davebryson/py-abci/blob/master/src/abci/server.py)
- [scala-tendermint-server](https://github.com/intechsa/scala-tendermint-server) (Scala): [server](https://github.com/InTechSA/scala-tendermint-server/blob/master/src/main/scala/lu/intech/tendermint/Server.scala)
- [scala-tendermint-server](https://web.archive.org/web/2023/https://github.com/InTechSA/scala-tendermint-server) (Scala; repository no longer available, archived copy)
- [kepler](https://github.com/f-o-a-m/kepler) (Rust): [server](https://github.com/f-o-a-m/kepler/blob/master/hs-abci-server/src/Network/ABCI/Server.hs)
2 changes: 1 addition & 1 deletion docs/tools/debugging/proposer-based-timestamps-runbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ to make sure your local clock is properly synchronized to NTP.

NTP configuration and tooling is very specific to the operating system and distribution
that your validator node is running. This guide assumes you have `timedatectl` installed with
[chrony](https://chrony.tuxfamily.org/), a popular tool for interacting with time
[chrony](https://chrony-project.org/), a popular tool for interacting with time
synchronization on Linux distributions. If you are using an operating system or
distribution with a different time synchronization mechanism, please consult the
documentation for your operating system to check the status and re-synchronize the daemon.
Expand Down
10 changes: 5 additions & 5 deletions internal/p2p/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The p2p package provides an abstraction around peer-to-peer communication.

Docs:

- [Connection](https://docs.tendermint.com/master/spec/p2p/connection.html) for details on how connections and multiplexing work
- [Peer](https://docs.tendermint.com/master/spec/p2p/node.html) for details on peer ID, handshakes, and peer exchange
- [Node](https://docs.tendermint.com/master/spec/p2p/node.html) for details about different types of nodes and how they should work
- [Pex](https://docs.tendermint.com/master/spec/p2p/messages/pex.html) for details on peer discovery and exchange
- [Config](https://docs.tendermint.com/master/spec/p2p/config.html) for details on some config option
- [Connection](../../spec/p2p/connection.md) for details on how connections and multiplexing work
- [Peer](../../spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange
- [Node](../../spec/p2p/node.md) for details about different types of nodes and how they should work
- [Pex](../../spec/p2p/messages/pex.md) for details on peer discovery and exchange
- [Config](../../spec/p2p/config.md) for details on some config option
2 changes: 1 addition & 1 deletion networks/local/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Local Cluster with Docker Compose

See the [docs](https://docs.tendermint.com/master/tools/docker-compose.html).
See the [docs](../../docs/tools/docker-compose.md).
2 changes: 1 addition & 1 deletion networks/remote/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Remote Cluster with Terraform and Ansible

See the [docs](https://docs.tendermint.com/master/tools/terraform-and-ansible.html).
See the [docs](../../docs/tools/terraform-and-ansible.md).
2 changes: 1 addition & 1 deletion proto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `.proto` files within this section are core to the protocol and updates must
### Steps

1. Make an issue with the proposed change.
- Within the issue members, from the Tendermint team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/README.md) may be requested.
- Within the issue members, from the Tendermint team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/) may be requested.
1a. Submission of an RFC as a pull request should be made to facilitate further discussion.
1b. Merge the RFC.
2. Make the necessary changes to the `.proto` file(s), [core data structures](../spec/core/data_structures.md) and/or [ABCI protocol](../spec/abci/app-requirements.md).
Expand Down
Loading
Loading