Skip to content

Automatically check all the markdown links #3258

@mlavacca

Description

@mlavacca

What would you like to be added:

We need to improve our CI to automatically check that we don't have broken links in the .md files. There are two different pieces of markdown we need to check:

  • plain .md files, such as the ones under /geps: we should check both internal and external links
  • documentation built with mkdocs: internal links are already checked by the tool; we need to check external links.

Why this is needed:

To improve our documentation robustness.

Metadata

Metadata

Assignees

Labels

good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.kind/featureCategorizes issue or PR as related to a new feature.priority/backlogHigher priority than priority/awaiting-more-evidence.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions