cats-effect
cats-effect copied to clipboard
CE3 Documentation Mega-TODO List
It's a little easier to consolidate these things into one place. Structuring things based on the sidebar:
-
Overview
- [ ] Need a beginner-friendly explainer of what
IO
is - [ ] Performance page touching on some top-line general numbers and concepts
- [ ] Tracing documentation
- [ ] Need a beginner-friendly explainer of what
- [x] Getting Started (this whole section should probably just be ported from CE2's microsite, because the walkthrough and topic is good)
- [ ] Best Practices (this should be a section covering best practices on how to structure your applications, ways to solve certain problems like dependency injection, etc; general "leveling up" stuff)
-
Standard Library
- [ ]
Console
- [ ]
Random
- [ ] Some of the articles in this section also need a bit of cleanup for consistency
- [ ]
- [ ] Ecosystem (I'm envisioning this as a use-case focused section with entries for "Http" (subsections "Client" and "Server"), "Kafka", etc; mostly just linking to external libraries and maybe giving a quickly copy/pasteable snippet for sbt and call-site)
- [ ] Scaling and Tuning (advice for how you run Cats Effect-powered services at scale and what it means to tune them for high load)
I volunteer to do the performance page
I volunteer to read the dependency injection page as I am not even in a kitten in this ecosystem yet (but I do know a bunch about DI ;-))