typelevel / typelevel/cats-effect
Cats-effect 3 IO docs are missing
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
cats-effect 2 has some great documentation around the IO datatype at https://typelevel.org/cats-effect/docs/2.x/datatypes/io.
These docs do not appear to exist for cats-effect version 3.
It would be great to add them.
Given how core this is to cats-effect, I suspect I've somehow missed where they are obviously located, but I can't find them.
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 comparing the existing cats-effect 2 IO documentation at the linked URL with the cats-effect 3 documentation structure in this repository. Add the missing version 3 IO documentation, ensuring it covers the corresponding core material and is reachable from the documentation navigation.
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
- 45/100