Lint markdown files for broken links
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 5.6k
- Forks
- 1.3k
- Avg merge
- 8h 47m
- Merged PRs (30d)
- 19
Description
Description
It is easy for links in such a big repository to get outdated. Instead of spot-checking those ourselves, use a tool.
Motivation
- Less manual labor
- No broken documentation
Current Implementation
Manual spot checking which is broken:
Related issues
Currently, the links within the root CHANGELOG.md for upgraded workspace crates are broken until we actually make a release because until then, the header in the file contains the unreleased heading.
This may change with https://github.com/libp2p/rust-libp2p/issues/2902 but shouldn't block this issue. I'd suggest that we keep the links working at all times. Having to trim off a couple of -unreleased snippets in the changelog at release time is a simple search and replace operation. Plus, if we have a tool in place that tells you about it, it is almost impossible to forget.
Are you planning to do it yourself in a pull request?
No.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the root CHANGELOG.md and the related issue 2902 context, then determine where an automated Markdown-link check belongs. Done means the repository reports broken links, including unreleased changelog links, instead of relying on manual spot checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100