[doc] external link checker
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
An offline link check using lychee was introduced to CI in https://github.com/lowRISC/opentitan/pull/17924 . It would be good to supplement this with an online (external) link check using lychee in order to keep tabs on how many broken links exist in the documentation. (The broken external links we know about are captured in https://github.com/lowRISC/opentitan/issues/17658). It would likely be best for this link checker to run in the nightlies.
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 pull request 17924 to see how the existing offline lychee check is configured, then compare the known broken links in issue 17658. Add an online external-link check to the nightly CI workflow; done means the nightly run reports documentation link failures without replacing the offline check.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100