Kuadrant / Kuadrant/docs.kuadrant.io
Improve visibility of Broken Links Check workflow
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
Problem
The repository already includes a "Broken Links Check" workflow (.github/workflows/broken-links-checker.yml), but it currently runs only through "workflow_dispatch" and is not mentioned in the README or contributor docs.
Since there are already some broken links in the current docs flow, contributors may not be aware that a link checker workflow already exists. It also appears that the workflow has not been used yet, which makes it even less discoverable for contributors.
Suggested Improvement
- Add a short mention of the
Broken Links Checkworkflow in the README/workflow documentation section. - Optionally clarify whether the workflow is intentionally manual-only or planned for scheduled/PR-based runs in the future.
Screenshot
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 with .github/workflows/broken-links-checker.yml and the README or contributor documentation. Confirm how the Broken Links Check workflow is currently triggered, then document it and clarify whether manual-only behavior is intentional. Done when contributors can find the workflow and understand its trigger policy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100