typelevel / typelevel/cats-effect
mdoc task should fail on warnings of broken links
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
#2955 fixes some broken links in the docs - mdoc warns about this, but it's a runtime warning log rather than a compiler warning so fatal warnings don't catch it. I'm not sure whether failing on warnings can be configured here or if this needs an issue in mdoc.
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 reading issue #2955 and the repository's mdoc task configuration, then check whether mdoc exposes a setting that turns broken-link runtime warnings into task failures. Done means the mdoc task reliably fails when documentation contains broken links, or the issue is redirected to mdoc if that behavior cannot be configured here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100