Skip to content

Add an automated check for dead URLS, relative Markdown links, and Markdown anchor tags #66

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

Open
sam-goldman opened this issue Jul 13, 2024 · 0 comments

Comments

@sam-goldman
Copy link
Contributor

sam-goldman commented Jul 13, 2024

Context

An example of a relative Markdown link is the path ./path/to/file.md in the Markdown snippet below:

[Link Text](./path/to/file.md)

An example of a Markdown anchor tag is #my-section in the Markdown snippet below:

[My section](#my-section)

Problem

Currently, we must manually check that URLs, relative Markdown links, and Markdown anchor tags are valid in user-facing areas of our codebase, particularly our documentation. This a tedious, error-prone process. Also, it's possible that URLs to external websites will become dead after they have been added to our documentation, in which case we won't know until somebody reports it.

Solution

We should have an automated process that checks for dead relative Markdown links and dead URLs. This process should be included in our CI process. We only need to check for dead Markdown links and anchor tags in Markdown files, but we should check for dead URLs in our entire codebase because we may include URLs in user-facing error messages in the future.

@sam-goldman sam-goldman added good first issue Good for newcomers and removed good first issue Good for newcomers labels Jul 13, 2024
@sam-goldman sam-goldman changed the title Add an automated check for dead Markdown links and URLs Add an automated check for dead URLS, relative Markdown links, and Markdown anchor tags Jul 13, 2024
@linear linear bot closed this as not planned Won't fix, can't repro, duplicate, stale Jan 16, 2025
@RPate97 RPate97 reopened this Jan 16, 2025
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

2 participants