Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve introduction documentation #48

Open
rssh opened this issue Jul 28, 2021 · 1 comment
Open

Improve introduction documentation #48

rssh opened this issue Jul 28, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rssh
Copy link
Owner

rssh commented Jul 28, 2021

Track documentation from the point of novice and rewrite parts, which are hard to follow.
// And not forget about experienced developers' paths, who will not want to read 'Monad-101' intro for documentation on each library. Maybe write in addition a separate introduction to the library?

@rssh rssh added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 28, 2021
@ScoreUnder
Copy link

For me, I first came into this project only knowing the user side of scala-async, which means a "Quick Start" for users like me would hopefully amount to little more than this snippet:

import cps.*
import cps.monads.FutureAsyncMonad

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants