ci: add check for markdown links (#912)

* add check for .md links

* fixing links

* fix broken links

* fix broken link

* adding config file

* ignore false positive

* check also README.md

* fix broken links in README

.github/workflows/linkchecker.yml

@@ -0,0 +1,14 @@
+name: Check Markdown links
+on: push
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the latest version of the code
+      - uses: actions/[email protected]
+
+      # Checks the status of hyperlinks in *.md files in docs/
+      - uses: gaurav-nelson/[email protected]
+        with:
+          folder-path: "docs"
+          file-path: './README.md'

README.md

@@ -45,11 +45,11 @@ Inspect the [Makefile](./Makefile) if curious.
 
 ## Testing
 
-See [testing docs](./docs/testing.md).
+See [testing docs](./docs/old/testing.md).
 
 ## Learn more
 
-- [IBC Docs](https://docs.cosmos.network/master/ibc/)
+- [IBC Docs](https://ibc.cosmos.network/)
 - [IBC Protocol](https://ibcprotocol.org/)
 - [IBC Specs](https://github.com/cosmos/ibc)
 - [Cosmos SDK documentation](https://docs.cosmos.network)

docs/docs/adrs/adr-002-throttle.md

@@ -93,7 +93,7 @@ while meter.IsPositiveOrZero() && entriesExist() {
 
 All CCV system properties should be maintained by implementing this feature, see: [CCV spec - Consumer Initiated Slashing](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/system_model_and_properties.md#consumer-initiated-slashing).
 
-One implementation-specific property introduced is that if any of the chain-specific packet data queues become larger than `MaxThrottledPackets (param)`, then the provider binary will panic, and the provider chain will halt. Therefore this param should be set carefully. See [SetThrottledPacketDataSize](../x/ccv/provider/keeper/throttle.go#L269). This behavior ensures that if the provider binaries are queuing up more packet data than machines can handle, the provider chain halts deterministically between validators.
+One implementation-specific property introduced is that if any of the chain-specific packet data queues become larger than `MaxThrottledPackets (param)`, then the provider binary will panic, and the provider chain will halt. Therefore this param should be set carefully. See `SetThrottledPacketDataSize`. This behavior ensures that if the provider binaries are queuing up more packet data than machines can handle, the provider chain halts deterministically between validators.
 
 ### Main Throttling Property
 

docs/docs/consumer-development/consumer-chain-governance.md

@@ -22,4 +22,4 @@ For an example, see [Neutron](https://github.com/neutron-org/neutron/).
 
 ## The Whitelist
 
-Not everything on a consumer chain can be changed by the consumer's governance. Some settings having to do with consensus etc. can only be changed by the provider chain. Consumer chains include a whitelist of parameters that are allowed to be changed by the consumer chain governance. For an example whitelist, see [Neutron's](https://github.com/neutron-org/neutron/blob/main/app/proposals_whitelisting.go).
+Not everything on a consumer chain can be changed by the consumer's governance. Some settings having to do with consensus etc. can only be changed by the provider chain. Consumer chains include a whitelist of parameters that are allowed to be changed by the consumer chain governance. For an example, see [Neutron's](https://github.com/neutron-org/neutron/blob/main/app/proposals_allowlisting.go) whitelist.

docs/docs/features/proposals.md

@@ -45,7 +45,7 @@ Minimal example:
     "binary_hash": "376cdbd3a222a3d5c730c9637454cd4dd925e2f9e2e0d0f3702fc922928583f1"
 }
 ```
-More examples can be found in the replicated security testnet repository [here](https://github.com/cosmos/testnets/blob/master/replicated-security/baryon-1/proposal-baryon-1.json) and [here](https://github.com/cosmos/testnets/blob/master/replicated-security/noble-1/proposal-noble-1.json).
+More examples can be found in the replicated security testnet repository [here](https://github.com/cosmos/testnets/blob/master/replicated-security/baryon-1/proposal-baryon-1.json) and [here](https://github.com/cosmos/testnets/blob/master/replicated-security/noble-1/start-proposal-noble-1.json).
 
 ## `ConsumerRemovalProposal`
 Proposal type used to suggest removing an existing consumer chain.

docs/docs/features/slashing.md

@@ -32,4 +32,5 @@ The offending validator will only be slashed (and tombstoned) if an `Equivocatio
 The offending validator will effectively get slashed and tombstoned on all consumer chains.
 :::
 
+<!-- markdown-link-check-disable-next-line -->
 You can find instructions on creating `EquivocationProposal`s [here](./proposals#equivocationproposal).

docs/docs/validators/overview.md

@@ -101,5 +101,5 @@ For more information check our the [Key assignment overview and guide](../featur
 ## References:
 - [Cosmos Hub Validators FAQ](https://hub.cosmos.network/main/validators/validator-faq.html)
 - [Cosmos Hub Running a validator](https://hub.cosmos.network/main/validators/validator-setup.html)
-- [Startup Sequence](https://github.com/cosmos/ics-testnets/blob/main/docs/Consumer-Chain-Start-Process.md)
+- [Startup Sequence](https://github.com/cosmos/testnets/blob/master/replicated-security/CONSUMER_LAUNCH_GUIDE.md#chain-launch)
 - [Submit Unjailing Transaction](https://hub.cosmos.network/main/validators/validator-setup.html#unjail-validator)

docs/old/protocol_audit.md

@@ -6,7 +6,7 @@ For a general overview of the quality assurance process necessary for the releas
 
 ## Reading / onboarding materials
 
-- Interchain Security [specification](https://github.com/cosmos/ibc/blob/marius/ccv/spec/app/ics-028-cross-chain-validation/README.md)
+- Interchain Security [specification](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md)
 - Quality Assurance [overview](./quality_assurance.md)
 
 ## Plan
@@ -16,11 +16,11 @@ Priority of concerns:
 2. The correctness (safety and liveness) of the Interchain Security protocol, see [QA overview](./quality_assurance.md#interchain-security-protocol-correctness).
 
 Sub-protocols to focus on:
-- [Channel Initialization](https://github.com/cosmos/ibc/blob/marius/ccv/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#channel-initialization)
+- [Channel Initialization](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#channel-initialization)
 
-- [Validator Set Update](https://github.com/cosmos/ibc/blob/marius/ccv/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#validator-set-update) with a focus on [Completion of Unbonding Operations](https://github.com/cosmos/ibc/blob/marius/ccv/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#completion-of-unbonding-operations) (**good starting point**)
+- [Validator Set Update](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#validator-set-update) with a focus on [Completion of Unbonding Operations](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#completion-of-unbonding-operations) (**good starting point**)
 
-- [Consumer Initiated Slashing](https://github.com/cosmos/ibc/blob/marius/ccv/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#consumer-initiated-slashing)
+- [Consumer Initiated Slashing](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/overview_and_basic_concepts.md#consumer-initiated-slashing)