-
Notifications
You must be signed in to change notification settings - Fork 0
Add markdown link validation to CI #5
Copy link
Copy link
Labels
area: ci-cdCI/CD workflowsCI/CD workflowsarea: docsDocumentationDocumentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomerspriority: lowNice to haveNice to havesize: small1-2 hours effort1-2 hours effort
Milestone
Metadata
Metadata
Assignees
Labels
area: ci-cdCI/CD workflowsCI/CD workflowsarea: docsDocumentationDocumentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomerspriority: lowNice to haveNice to havesize: small1-2 hours effort1-2 hours effort
Type
Projects
Status
Done
Description
Add a CI step that validates all internal and external links in markdown files. As the project grows, broken links in docs become a maintenance burden.
Why
The project has 8+ documentation files, a README, CONTRIBUTING.md, and CLAUDE.md — all with cross-references. Catching broken links automatically prevents contributor frustration and maintains documentation quality.
Acceptance Criteria
.github/workflows/ci.yml.mdfiles in the repo root anddocs/directoryImplementation Options
Using markdown-link-check:
Or using lychee: