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

Overview and Resource Safety section of documentation #136

Merged
merged 18 commits into from
Jun 19, 2020

Conversation

Avasil
Copy link
Contributor

@Avasil Avasil commented Jun 16, 2020

#113

If you want to build the website locally:

sbt docs/docusaurusCreateSite
website/yarn start

I will have to run new benchmarks since I mention them and there were some changes in competing libraries

cc @Executioner1939

@Avasil Avasil requested review from alexandru and paualarco June 16, 2020 19:05
docs/overview.md Outdated Show resolved Hide resolved
@Avasil Avasil changed the title Overview section of documentation Overview and Resource Safety section of documentation Jun 17, 2020
docs/comparison.md Outdated Show resolved Hide resolved
docs/comparison.md Outdated Show resolved Hide resolved
docs/comparison.md Outdated Show resolved Hide resolved
docs/comparison.md Outdated Show resolved Hide resolved
docs/comparison.md Outdated Show resolved Hide resolved
docs/resourcesafety.md Outdated Show resolved Hide resolved
docs/resourcesafety.md Outdated Show resolved Hide resolved
docs/resourcesafety.md Outdated Show resolved Hide resolved
docs/resourcesafety.md Outdated Show resolved Hide resolved
docs/resourcesafety.md Outdated Show resolved Hide resolved
Avasil and others added 14 commits June 18, 2020 18:17
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
Co-authored-by: Richard <shadowrhyder@gmail.com>
@Avasil
Copy link
Contributor Author

Avasil commented Jun 18, 2020

Thanks for the feedback @Executioner1939 and @paualarco

I have rewritten the Motivation section - I would love to hear your thoughts.
I'm trying to convey how I see Monix in the ecosystem, but I'm a bit afraid I give an impression like Monix BIO is not purely functional. I don't want to scare fellow FP enthusiasts. :D

It would be also good to know if you have a completely view of Monix.

@Avasil Avasil merged commit f34ec58 into monix:master Jun 19, 2020
@paualarco
Copy link
Member

@Avasil it's a good introduction actually! Looking forward to see more documentation to learn more :)
Although you are giving personal opinion, I would suggest avoiding expressions like To me, the big difference generally speaking in first person :P
You would also like to fix the format of this part to make it a valuable alternative. For instance, if you are a happy user of Typelevel libraries (http4s, fs2, doobie etc.) you might find that.

@paualarco
Copy link
Member

paualarco commented Jun 19, 2020

It would be also good to know if you have a completely view of Monix.

Did you mean that if overview section of documentation gives you a good view on why /when to use Bio vs Monix?

@Avasil
Copy link
Contributor Author

Avasil commented Jun 20, 2020

Although you are giving personal opinion, I would suggest avoiding expressions like To me, the big difference generally speaking in first person :P

Yeah, I agree, it's not a blog post. I'll make another pass, maybe I can rephrase it

It would be also good to know if you have a completely view of Monix.

Did you mean that if overview section of documentation gives you a good view on why /when to use Bio vs Monix?

No, in Monix Niche section I am writing about Monix in general.
It would be better to put it in a shared place in docs for all of Monix, but it's not organized like that atm, and I wanted to mention it. I hope it's not too confusing in the current state.

Currently I want to write perhaps basic, but complete documentation for monix-bio that can be understood in isolation (without knowing about any effect types).

In the next step, I would like to share BIO and Task docs because everything apart from error handling could be almost the same. I wonder if it's hard to do something like Spark with different APIs: https://spark.apache.org/docs/latest/quick-start.html but I can always copy paste. :D Current documentation of monix.eval.Task is a few years old, and I want to give it a revamp along the way.

Then if I'm not completely burned out, I'll attack Observable. Although I would like to create a sample app at some point so it will take me a while :D

@paualarco
Copy link
Member

paualarco commented Jun 20, 2020

No, in Monix Niche section I am writing about Monix in general.

I think it is good, but agree it is not that related with monix-bio, but with monix in general.

In the next step, I would like to share BIO and Task docs because everything apart from error handling could be almost the same.

IMO monix-bio looks very close to be another sub-module of monix and not as a different project. But at the same time it is not that mature.

So, I just agree that would make lot of sense merging task and bio docs, and that would be a good opportunity to start approaching the monix future plans of moving documentation to a better organised format (docusaurus).

I wonder if it's hard to do something like Spark with different APIs: https://spark.apache.org/docs/latest/quick-start.html but
I can always copy paste. :D

That would be awesome but no idea how to do so atm, but it should not be too difficult ;D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants