typelevel / typelevel/cats-effect
Reorganize and fix core docs
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
There's a lot of redundancy right now, particularly with the Scaling and Tuning section (which should be collapsed into IORuntime Configuration for the time being). We also need docs for IO and Resource at a minimum in that section, and probably also IOApp.
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 locating the core documentation sections named in the issue, especially Scaling and Tuning and IORuntime Configuration, and compare their overlapping content. Consolidate Scaling and Tuning into IORuntime Configuration, add documentation for IO and Resource, and clarify whether IOApp is also required before considering the work complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100