search

hyperledger-iroha / iroha

Iroha - A simple, enterprise-grade decentralized ledger
https://wiki.hyperledger.org/display/iroha
Apache License 2.0
438 stars 280 forks source link

Automatically detect broken hyperlinks in the documentation #5187

Open aoyako opened 2 days ago

aoyako commented 2 days ago

It seems that there are some of the broken hyperlinks in the documentation and code:

  1. https://github.com/hyperledger/iroha/blob/34b565545032fce810a86acd8f42f8a4a80946f6/docs/README.md?plain=1#L6
  2. https://github.com/hyperledger/iroha/blob/34b565545032fce810a86acd8f42f8a4a80946f6/docs/source/iroha_2_whitepaper.md?plain=1#L342
  3. https://github.com/hyperledger/iroha/blob/34b565545032fce810a86acd8f42f8a4a80946f6/crates/iroha_telemetry/src/metrics.rs#L266

While it is possible to check every release manually, another approach would be to check for 404 in the CI pipeline automatically. Another thing to consider is that some links referring to GitHub issues/PR can be ignored, improving the performance. I can't say what action on the marketplace is best for this scenario, so additional research is probably needed.