Comments (4)
https://typelevel.org/cats
and link to it from the README.
from cats-effect.
I agree with all of this. My general preference for documentation is to have a doc/
directory (containing markdown) in the project root, so things remain versioned with the project. Doing something more elaborate with tut is also completely reasonable. @ochrons Would you be interested in playing around with getting started on this?
from cats-effect.
@ochrons we have a documentation website now, at: https://typelevel.org/cats-effect/
Here's the IO document: https://typelevel.org/cats-effect/datatypes/io.html
Is this what you wanted? Can we close this issue?
from cats-effect.
Yeah, looking good now. Thanks for the documentation effort!
from cats-effect.
Related Issues (20)
- `IO.cede.foreverM.timeoutTo(...)` timeout flake HOT 2
- Replace non-`Gen` kernel variants with existential form HOT 9
- `steal timers` test seems to be legitimately failing
- Can we push to make `IOFiber` fit in 64 bytes? HOT 2
- Round timer durations up to 0 HOT 2
- `synchronous queue should not lose takers when offerer is canceled and there are no other takers` flake HOT 6
- Update migration guide for newer CE3 stuff HOT 1
- flaky `DefaultContSpec` in CI [JVM] HOT 1
- `Queue.synchronous` may suffer from the "lost item" problem HOT 2
- error in bracket finalizer can stop fiber from progressing. HOT 2
- isn't 3.5.0 `async` a breaking API change?
- `IOAppSpec` starvation test is a bit flaky HOT 4
- Add `Async#evalOn(executor)` or `Async#evalOnExecutor(executor)` HOT 3
- Add semantically blocking `get` in AtomicCell. HOT 6
- Document JMX stuff
- Failed fibers does not log when run with `scala-cli` HOT 6
- Add FAQ about why to prefer `Dispatcher#unsafeRun` to `IO#unsafeRun`
- Add FAQ for `unused value of type cats.effect.IO[Unit] (add : Unit to discard silently)`
- Experiment: specialized `IO`-runloop for Native based on `setjmp`/`longjmp` HOT 3
- `configure-pagefile-action` failed in CI HOT 3
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-effect.