ImperialCollegeLondon / ImperialCollegeLondon/FINESSE_processing
Add link checker workflow
Open
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We should add a GitHub workflow to automatically check hyperlinks in documentation.
The RSE team commonly does this for other projects, e.g. with FINESSE: https://github.com/ImperialCollegeLondon/FINESSE/blob/main/.github/workflows/check-links.yml
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the referenced FINESSE workflow at .github/workflows/check-links.yml and inspect this repository's documentation locations. Add a GitHub workflow that automatically checks documentation hyperlinks, then confirm the workflow runs successfully and reports broken links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100