chaoss
Identify and Fix Broken Links in README.md
Replication issue
On the README.md click on 8knot
Task
Update the broken link 8knot with the correct 8knot
Improvement
Implement a GitHub Action to automate the identification of broken links in the project's documentation.
Reason
Regularly checking for broken links helps maintain the quality and reliability of documentation, ensuring users have access to accurate resources.
Benefit
Automating the detection of broken links ensures a better user experience, saves time for maintainers, and enhances project credibility and trust.
Hi @CyrilBaah, I’d like to work on this issue. I can start by identifying and fixing the broken 8knot link in the README.md, and then work on adding a GitHub Action to automate broken link checks in the documentation.
Please let me know if I can proceed. Thanks!
I have added a job in workflow using lychee to solve the issue #3152, which will check if there is any broken link in README.md. Please review my PR.
Hi @CyrilBaah, I have added a job in workflow using lychee to solve the issue https://github.com/chaoss/augur/issues/3152, which will check if there is any broken link in README.md. Please review my PR.
is the issue completed??
No, there have been several PRs for it already though. I believe both are still in review. It seems like one issue with merging a CI solution is that it will immediately cause the CI to fail because there are broken links in the repo.
If you are looking for a way to help out, i think submitting a PR that corrects all the existing broken links detected by these two existing PRs would help make sure the repo is in a clean, working state to introduce such a CI job.
Hey, is this issue open. I would like to contribute and fix the broken links (this will be my first contribution)
Hey, is this issue open. I would like to contribute and fix the broken links (this will be my first contribution)
I think above message is enough for your doubt! let me know if you're working on this