A while ago I wrote a document explaining the inte...

# arrow

[simon.vergauwen]

A while ago I wrote a document explaining the internals of Kotlin Coroutines from the standard library, and how it relates to the internals of Arrow Fx Coroutines as a contributors guide, or for anyone interested in better understanding the internals. This has never been promoted or shown anywhere in a visible place, where would you expect to find/see this? Any feedback on the README is also welcome 😉

https://github.com/arrow-kt/arrow-fx/tree/master/arrow-fx-coroutines

[julian]

Seems like a good place for it. That's where I'd look first for this sort of thing.

[julian]

It could also be sub-page of the Arrow Fx Quick Start section. That's another place I'd look.

[simon.vergauwen]

Good suggestions! So something like a "Contributors Guide" under the "Quick Start"?

[PhBastiani]

For me, it's too long and above all too technical for a README. The newcomer to Arrow can be lost on the purpose of the module; and, what differentiates Arrow from the Jetbrains solution.

As you write, this paper approaches the subject from a point of view not seen elsewhere.

This document should be therefore be highlighted... Your suggestion for the WEB site is, I believe, the right one

[simon.vergauwen]

You make a very good point Philippe! Perhaps the original README.MD would suit the module README.MD better? And this could belong under a CONTRIBUTOR.MD file linked there, and/or on the main README.MD?

Reference to old README.MD:
https://github.com/arrow-kt/arrow-fx/blob/ad96d2e8348bc56ad20e1014f0e9059622cd259d/arrow-fx-coroutines/README.MD

[Jannis]

Well it clearly states that it's for contributing and understanding how its internals work right? But imo it does not clearly link to actual documention on how to use it well enough. Either way a section in docs for contributing and/or a reference in a CONTRIBUTOR.MD or similar