Check that links work before deploying
Open
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 238
- Forks
- 107
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 2
Description
Since our internal links now all use meta variables, I'm not sure if there's any software out there that can check link validity at the source code stage. (We could probably write one, but that feels a bit excessive)
So instead we should probably run some sort of HTML link checker on the Quarto output itself, perhaps https://github.com/filiph/linkcheck
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 by reviewing the generated Quarto HTML and the proposed filiph/linkcheck tool; no repository file or test is named. Completion means running an HTML link check on the documentation output before deployment and addressing any invalid links it reports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100