typelevel / typelevel/cats-effect
Compile all documentation using mdoc
Open
Nobody has claimed this yet.
:books: docs
🥺 help wanted
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
In some places, you'll find docs using scala instead of scala mdoc. It should all be compiled by mdoc. E.g. monadcancel.
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 docs/typeclasses/monadcancel.md and inspect how its examples use scala versus scala mdoc. Search the documentation for other examples using scala, then update the affected documentation so it is compiled by mdoc throughout; done means no remaining documentation uses the old form.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100