Add docs for library breakdown (#900)

* Docs for library breakdown

* Add arrow-generic

README.md

@@ -11,6 +11,7 @@ It includes the most popular data types, type classes and abstractions such as `
 
 - [Documentation](http://arrow-kt.io)
 - [Patterns](http://arrow-kt.io/docs/patterns/glossary/): tutorials and approaches to day-to-day challenges using FP 
+- [Libraries](http://arrow-kt.io/docs/quickstart/libraries/): all the libraries provided by Λrrow
 - [Type classes](http://arrow-kt.io/docs/typeclasses/intro/): defining behaviors for data
 - [Data types](http://arrow-kt.io/docs/datatypes/intro/): common abstractions
 - [Effects](http://arrow-kt.io/docs/effects/io/): interfacing with external systems

modules/docs/arrow-docs/docs/_data/menu.yml

@@ -6,6 +6,9 @@ options:
       - title: Index
         url: /docs/
 
+      - title: Libraries
+        url: /docs/quickstart/libraries/
+
       - title: Blogs & Presentations
         url: /docs/quickstart/blogs/
 

modules/docs/arrow-docs/docs/docs/README.md

@@ -16,6 +16,7 @@ It includes the most popular data types, type classes and abstractions such as `
 Use the list below to learn more about Λrrow's main features.
 
 - [Patterns](http://arrow-kt.io/docs/patterns/glossary/): tutorials and approaches to day-to-day challenges using FP 
+- [Libraries](http://arrow-kt.io/docs/quickstart/libraries/): all the libraries provided by Λrrow
 - [Type classes](http://arrow-kt.io/docs/typeclasses/intro/): defining behaviors for data
 - [Data types](http://arrow-kt.io/docs/datatypes/intro/): common abstractions
 - [Effects](http://arrow-kt.io/docs/effects/io/): interfacing with external systems

modules/docs/arrow-docs/docs/docs/quickstart/libraries/README.md

@@ -0,0 +1,160 @@
+---
+layout: docs
+title: Libraries
+permalink: /docs/quickstart/libraries/
+---
+
+## Core Libraries
+
+Arrow is a modular set of libraries that build on top of each other to provide higher level features.
+
+One of our design principles is to keep each library is kept as lean as possible to avoid pulling unnecessary dependencies,
+specially to support Android developers where app size affects performance.
+
+In this section we'll describe all the modules, alongside an ooverview and a list of all the constructs inside.
+
+### arrow-core
+
+{:.beginner}
+beginner
+
+The smallest set of constructs necessary to start in FP, and that other libraries can build upon.
+The focus here is on API design and abstracting small code patterns.
+
+Datatypes: [`Either`]({{ '/docs/datatypes/either/' | relative_url }}), [`Option`]({{ '/docs/datatypes/option/' | relative_url }}), [`Try`]({{ '/docs/datatypes/try/' | relative_url }}), [`Eval`]({{ '/docs/datatypes/eval/' | relative_url }}), [`Id`]({{ '/docs/datatypes/id/' | relative_url }}), `TupleN`, `Function0`, `Function1`, `FunctionK`
+
+### arrow-syntax
+
+{:.beginner}
+beginner
+
+Multiple extensions functions to work better with function objects and collections.
+
+Dependencies: arrow-core
+
+For function objects the library provides composition, currying, partial application, memoization, pipe operator, complement for predicates, and several more helpers.
+
+For collections, arrow-syntax provides `firstOption`, tail, basic list traversal, and tuple addition.
+
+### arrow-typeclasses
+
+{:.intermediate}
+intermediate
+
+All the basic [typeclasses]({{ '/docs/typeclasses/intro' | relative_url }}) that can compose into a simple program.
+
+Dependencies: arrow-core
+
+Datatypes: [`Const`]({{ '/docs/typeclasses/const/' | relative_url }})
+
+Typeclasses: [`Alternative`]({{ '/docs/typeclasses/alternative/' | relative_url }}), [`Bimonad`]({{ '/docs/typeclasses/bimonad/' | relative_url }}), [`Inject`]({{ '/docs/typeclasses/inject/' | relative_url }}), [`Reducible`]({{ '/docs/typeclasses/reducible/' | relative_url }}), [`Traverse`]({{ '/docs/typeclasses/traverse/' | relative_url }}), [`Applicative`]({{ '/docs/typeclasses/applicative/' | relative_url }}), [`Comonad`]({{ '/docs/typeclasses/comonad/' | relative_url }}), [`Eq`]({{ '/docs/typeclasses/eq/' | relative_url }}), [`Monad`]({{ '/docs/typeclasses/monad/' | relative_url }}), [`Monoid`]({{ '/docs/typeclasses/monoid/' | relative_url }}), [`Semigroup`]({{ '/docs/typeclasses/semigroup/' | relative_url }}), [`ApplicativeError`]({{ '/docs/typeclasses/applicativeerror/' | relative_url }}), [`Foldable`]({{ '/docs/typeclasses/foldable/' | relative_url }}), [`MonoidK`]({{ '/docs/typeclasses/monoidk/' | relative_url }}), [`SemigroupK`]({{ '/docs/typeclasses/semigroupk/' | relative_url }}), [`Bifoldable`]({{ '/docs/typeclasses/bifoldable/' | relative_url }}), [`Functor`]({{ '/docs/typeclasses/functor/' | relative_url }}), [`MonadError`]({{ '/docs/typeclasses/monaderror/' | relative_url }}), [`Order`]({{ '/docs/typeclasses/order/' | relative_url }}), [`Show`]({{ '/docs/typeclasses/show/' | relative_url }}), `Composed`
+
+### arrow-data
+
+{:.beginner}
+beginner
+
+This library focuses on expanding the helpers provided by typeclasses to existing constructs, like the system collections.
+You can also find more advanced constructs for pure functional programming like the `RWS` datatypes, or transformers.
+
+Dependencies: arrow-typeclasses
+
+Datatypes: [`Cokleisli`]({{ '/docs/datatypes/cokleisli/' | relative_url }}), [`Coreader`]({{ '/docs/datatypes/coreader/' | relative_url }}), [`Ior`]({{ '/docs/datatypes/ior/' | relative_url }}), [`ListK`]({{ '/docs/datatypes/listK/' | relative_url }}), [`NonEmptyList`]({{ '/docs/datatypes/nonEmptyList/' | relative_url }}), [`SequenceK`]({{ '/docs/datatypes/sequenceK/' | relative_url }}), [`SortedMapK`]({{ '/docs/datatypes/sortedMapK/' | relative_url }}), [`StateT`]({{ '/docs/datatypes/stateT/' | relative_url }}), [`WriterT`]({{ '/docs/datatypes/writerT/' | relative_url }}), [`Coproduct`]({{ '/docs/datatypes/coproduct/' | relative_url }}), [`EitherT`]({{ '/docs/datatypes/eitherT/' | relative_url }}), [`Kleisli`]({{ '/docs/datatypes/kleisli/' | relative_url }}), [`MapK`]({{ '/docs/datatypes/mapK/' | relative_url }}), [`OptionT`]({{ '/docs/datatypes/optionT/' | relative_url }}), [`Reader`]({{ '/docs/datatypes/reader/' | relative_url }}), [`SetK`]({{ '/docs/datatypes/setK/' | relative_url }}), [`State`]({{ '/docs/datatypes/state/' | relative_url }}), [`Validated`]({{ '/docs/datatypes/validated/' | relative_url }})
+
+### arrow-instances-(core, data)
+
+{:.intermediate}
+intermediate
+
+These two libraries include the possible [typeclass instances]({{ '/docs/patterns/glossary/#instances' | relative_url }}) that can be implemented for the datatypes in arrow-core and arrow-data, and some basic types.
+
+Dependencies: arrow-typeclasses, and either arrow-core or arrow-data
+
+### arrow-mtl
+
+{:.advanced}
+advanced
+
+Advanced [typeclasses]({{ '/docs/typeclasses/intro' | relative_url }}) to be used in programs using the Tagless-final architecture.
+
+It also includes the instances available for datatypes in both arrow-core and arrow-data
+
+Dependencies: arrow-instances-data
+
+Typeclasses: [`FunctorFilter`]({{ '/docs/typeclasses/functorFilter/' | relative_url }}), [`MonadFilter`]({{ '/docs/typeclasses/monadFilter/' | relative_url }}), [`MonadReader`]({{ '/docs/typeclasses/monadReader/' | relative_url }}), [`MonadWriter`]({{ '/docs/typeclasses/monadWriter/' | relative_url }}), [`MonadCombine`]({{ '/docs/typeclasses/monadCombine/' | relative_url }}), [`MonadState`]({{ '/docs/typeclasses/monadState/' | relative_url }}), [`TraverseFilter`]({{ '/docs/typeclasses/traverseFilter/' | relative_url }})
+
+## Extension libraries
+
+These libraries are hosted inside the arrow repository building on the core, to provide higher level constructs to deal with concepts rather than code abstraction.
+
+### arrow-optics
+
+{:.beginner}
+beginner
+
+Optics is the functional way of handling immutable data and collections in a way that's boilerplate free and efficient.
+
+It can be used alongside annotation processing to generate [simple DSLs]({{ '/docs/optics/dsl/' | relative_url }}) that read like imperative code.
+
+For all the new typeclasses it also includes the instances available for basic types and datatypes in both arrow-core and arrow-data.
+
+Datatypes: [`Fold`]({{ '/docs/optics/fold/' | relative_url }}), [`Getter`]({{ '/docs/optics/getter/' | relative_url }}), [`Iso`]({{ '/docs/optics/iso/' | relative_url }}), [`Lens`]({{ '/docs/optics/lens/' | relative_url }}), [`Optional`]({{ '/docs/optics/optional/' | relative_url }}), [`Prism`]({{ '/docs/optics/prism/' | relative_url }}), [`Setter`]({{ '/docs/optics/setter/' | relative_url }}), [`Traversal`]({{ '/docs/optics/traversal/' | relative_url }})
+
+Typeclasses: [`At`]({{ '/docs/optics/at/' | relative_url }}), [`Each`]({{ '/docs/optics/each/' | relative_url }}), [`FilterIndex`]({{ '/docs/optics/filterIndex/' | relative_url }}), [`Index`]({{ '/docs/optics/index/' | relative_url }})
+
+### arrow-effects
+
+{:.intermediate}
+intermediate
+
+The effects library abstracts over concurrency frameworks using typeclasses. Additionally it provides its own concurrency primitive, called IO.
+
+Datatypes: [`IO`]({{ '/docs/effects/io/' | relative_url }})
+
+Typeclasses: [`MonadSuspend`]({{ '/docs/effects/monadsuspend/' | relative_url }}), [`Async`]({{ '/docs/effects/async/' | relative_url }}), [`Effect`]({{ '/docs/effects/effect/' | relative_url }})
+
+
+### arrow-effects-(rx2, reactor, kotlinxcoroutines)
+
+{:.intermediate}
+intermediate
+
+Each of these modules provides wrappers over the datatypes in each of the libraries that implement all the typeclasses provided by arrow-effects
+
+[Rx]({{ 'docs/integrations/rx2/' | relative_url }}): `Observable`, `Flowable`, `Single`
+
+[Reactor]({{ 'docs/integrations/reactor/' | relative_url }}): `Flux`, `Mono`
+
+[kotlinx.coroutines]({{ 'docs/integrations/kotlinxcoroutines/' | relative_url }}): `Deferred`
+
+### arrow-recursion
+
+{:.advanced}
+advanced
+
+Recursion schemes is a construct to work with recursive data structures in a way that decuples structure and data, and allows for ergonomy and performance improvements.
+
+Datatypes: [`Fix`]({{ '/docs/recursion/fix/' | relative_url }}), [`Mu`]({{ '/docs/recursion/mu/' | relative_url }}), [`Nu`]({{ '/docs/recursion/nu/' | relative_url }})
+
+Typeclasses: [`Corecursive`]({{ '/docs/recursion/corecursive/' | relative_url }}), [`Recursive`]({{ '/docs/recursion/recursive/' | relative_url }}), [`Birecursive`]({{ '/docs/recursion/birecursive/' | relative_url }})
+
+### arrow-free
+
+{:.advanced}
+advanced
+
+The [Free datatype]({{ '/docs/free/free/' | relative_url }}) is a way of interpreting domain specific languages from inside your program, including a configurable runner and flexible algebras.
+This allows optimization of operations like operator fusion or parallelism, while remaining on your business domain.
+
+Datatypes: [`Free`]({{ '/docs/free/free/' | relative_url }}), [`FreeApplicative`]({{ '/docs/free/freeapplicative/' | relative_url }}), [`Cofree`]({{ '/docs/free/cofree/' | relative_url }}), [`Yoneda`]({{ '/docs/free/yoneda/' | relative_url }}), [`Coyoneda`]({{ '/docs/free/coyoneda/' | relative_url }})
+
+## Annotation processors
+
+These libraries focus on meta-programming to generate code that enables other libraries and constructs.
+
+### arrow-generic
+
+{:.advanced}
+advanced
+
+It allows anonating data classes with [`@product`]({{ '/docs/generic/product/' | relative_url }}) to enable them to be structurally deconstructed in tuples and heterogeneous lists.