Comments (4)
@djspiewak , I would love to help with docs. with your and the rest of the team's guidance. Anything, in particular, you would like first?
from cats-mtl.
I think the first step is to roughly align what we have with what the hierarchy actually looks like. I did a rough search/replace on names when all the classes were renamed, an @LukaJCB removed (some of?) the old bits about ControlLayer
, but we should take a pass over everything to make sure it's not talking about stuff that doesn't exist anymore.
Once we've done that, my rough general ideas fall somewhere along the following lines:
- A page talking about how the lifting works (this would mention
MonadPartialOrder
, but mostly just call out that instances are simply on companions and it's straightforward) - An introduction page to the concept of MTL capability classes. Most people equate monad transformers with "complex nested types, terrible errors, and a lot of opaque
lift
ing", and capability classes completely solve that problem. Beginning to get people thinking in terms of capability-declaring type signatures (thisF
has the capability to perform dependency injection with typeR
), that type of thing. The hardest leap is just reading the signatures and getting comfortable with the amount of abstraction floating around. - A collection of use-cases. Dependency injection is a nice one because it's so obvious, but we can also talk about error channels and the like.
- I still think
Chronicle
is weird…
from cats-mtl.
@djspiewak, I'm very interested in writing documentation. I'm a beginner in Cats and feel that forcing myself to read through the codebase and understand the motivations enough to write documentation would be a great learning experience. Let me know what I can do.
Thanks,
Brad
from cats-mtl.
- A collection of use-cases. Dependency injection is a nice one because it's so obvious, but we can also talk about error channels and the like.
Self-contained use case examples would be super helpful. Something a newcomer to MTL can copy, play with, and then modify to their needs.
The mtl docs currently have small examples for each class, but some examples showing pairs and "stacks" of mtl classes working together to solve a realistic problem would make a nice addition.
One use case I think there'd be a lot (perhaps too much!) interest in would be how to emulate the capabilities of ZIO using a mtl stack... 🤔 💭
from cats-mtl.
Related Issues (20)
- Hand-write (or scalafix) syntax stuff
- Add a cats-mtl-free submodule
- Inductive instances over ContT HOT 4
- Documentation links return 404 HOT 1
- Add low-priority materializations for Handle in terms of ApplicativeError HOT 3
- Inconsistent use of def vs val in embedded typeclass
- New typeclass to run reader-like effects HOT 1
- Can't migrate from v0.7: StateT[EitherT, ...], ...] vs. EitherT[StateT, ...], ...] HOT 1
- Release for 3.0.0-RC2 HOT 1
- Release for Scala 3 HOT 3
- CI publishing failed HOT 1
- Website publish is failing in CI
- Release v1.3.0
- Scaladoc link is invalid now HOT 3
- handle error with partial function
- Cat
- Rebranding Cats MTL to emphasize the Capabilities, not the Monad Transformers HOT 11
- Different Ask typeclass requirements in a same stack monad HOT 3
- Support Scala Native 0.5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cats-mtl.