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.

Sign up for GitHub

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

Jump to bottom

Lint markdown files for broken links #3032

Open
thomaseizinger opened this issue Oct 16, 2022 · 0 comments · May be fixed by #4871
Open

Lint markdown files for broken links #3032

thomaseizinger opened this issue Oct 16, 2022 · 0 comments · May be fixed by #4871
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted

Comments

@thomaseizinger
Copy link
Contributor

thomaseizinger commented Oct 16, 2022 •
edited

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:

image

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 #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.
@thomaseizinger thomaseizinger added difficulty:easy help wanted getting-started Issues that can be tackled if you don't know the internals of libp2p very well labels Oct 16, 2022
@thomaseizinger thomaseizinger mentioned this issue Apr 25, 2023
Merged
4 tasks
@thomaseizinger thomaseizinger linked a pull request Nov 16, 2023 that will close this issue
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci: lint for broken markdown links libp2p/rust-libp2p
1 participant
@thomaseizinger