typelevel / typelevel/cats-effect
Write a concretely focused “new user” guide
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Easy guide for getting started with Cats Effect. Probably should be several separate pages. Should include some quick motivation and a note on "advanced" style (fully polymorphic and flexible, recommended for teams comfortable with FP and effects) vs "concrete" style (hard code IO) for teams that are less familiar, and also noting how you can mix and migrate the two styles (LiftIO). Should cover JVM and JS.
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 existing Cats Effect documentation and beginner entry points for JVM and JS. Organize the guide into focused pages covering motivation, concrete versus advanced styles, mixing and migration with LiftIO, and both platforms; done means these topics are clearly covered for new users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100