typelevel / typelevel/cats-effect
Improve docs for using `IO` outside of `IOApp`
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
(My summary/analysis of this Discord discussion.)
We push IOApp hard, with good reason.
However, if you want to use Cats Effect to build a library/module/component whatever that can be called from the outside world then IOApp is not an option. So perhaps we need a section describing good patterns for this.
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 the existing documentation on IOApp and review the linked Discord discussion for the intended patterns. Done means the Cats Effect docs include a clear section explaining how to use IO outside IOApp when building a library, module, or component.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100