Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically detect broken hyperlinks in the documentation #5187

Open
aoyako opened this issue Oct 23, 2024 · 0 comments
Open

Automatically detect broken hyperlinks in the documentation #5187

aoyako opened this issue Oct 23, 2024 · 0 comments

Comments

@aoyako
Copy link
Contributor

aoyako commented Oct 23, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant