Move user documentation under the User node

docs/Developer/Contributing.md

@@ -90,9 +90,9 @@ Here is a quick checklist for a PR, for details please see the next section:
 * [Performance benchmarks](/benchmark) are added, where applicable
 * No significant regressions are reported by [performance benchmarks](/docs/Developer/Benchmarks.md)
 * Haddock documentation is added to user visible APIs and data types
-* Tutorial module, [Introduction](/docs/Tutorials/Introduction.md), and [guides](/docs) are
+* Tutorial module, [Introduction](/docs/User/Tutorials/Introduction.md), and [guides](/docs) are
   updated if necessary.
-* [Changelog](/docs/ProjectRelated/Changelog.md) is updated if needed
+* [Changelog](/docs/User/ProjectRelated/Changelog.md) is updated if needed
 * The code conforms to the license, it is not stolen, credit is given,
   copyright notices are retained, original license is included if needed.
 

docs/Developer/MAINTAINING.md

@@ -138,7 +138,7 @@
     * Wait for final CI tests to pass:
 
         * Mask out the build status lines from the
-          [docs/Introduction.md](/docs/Tutorials/Introduction.md)
+          [docs/Introduction.md](/docs/User/Tutorials/Introduction.md)
         * Upload to hackage
           * Use a clean workspace to create source distribution
           by freshly cloning the git repository. The reason for

docs/User/Explanation/Overview.md

@@ -95,7 +95,7 @@ can be constructed from monadic effects, not just pure elements.  Streams are
 processed just like lists, with list like combinators, except that they are
 monadic and work in a streaming fashion. In other words streamly just completes
 what lists lack, you do not need to learn anything new. Please see [streamly vs
-lists](/docs/HowTo/streamly-vs-lists.md) for a detailed comparison.
+lists](/docs/User/HowTo/streamly-vs-lists.md) for a detailed comparison.
 
 Not surprisingly, the monad instance of streamly is a list transformer, with
 concurrency capability.

docs/User/Explanation/unified-abstractions.md

@@ -8,7 +8,7 @@ ecosystem.
 This document discusses the related packages in the Haskell ecosystem
 and how streamly unifies, overlaps, or compares with those. We provide
 simple code snippets for illustrations, for a better overview of the
-library please see the [Streamly Quick Overview](/docs/Tutorials/Introduction.md) document.
+library please see the [Streamly Quick Overview](/docs/User/Tutorials/Introduction.md) document.
 
 ## Existing Haskell Libraries
 
@@ -94,7 +94,7 @@ uses a vector-like stream representation which is amenable to
 low-level code having performance comparable to C.
 
 To further understand the similarity with list API, please see [Streamly vs.
-lists](/docs/HowTo/streamly-vs-lists.md).
+lists](/docs/User/HowTo/streamly-vs-lists.md).
 For comparison of Streamly performance with other libraries see
 [streaming benchmarks](https://github.com/composewell/streaming-benchmarks).
 
@@ -161,7 +161,7 @@ The same combinators that are used for serial streams e.g. 'unfoldrM',
 'replicateM', 'repeatM' work concurrently when used at the appropriate type.
 It allows concurrent programs to be written declaratively and composed
 idiomatically. They are not much different than serial programs.  See
-[Streamly vs async](/docs/HowTo/streamly-vs-async.md)
+[Streamly vs async](/docs/User/HowTo/streamly-vs-async.md)
 for a comparison of Streamly with the `async` package.
 
 Streamly provides concurrent scheduling and looping similar to to

docs/User/HowTo/faq.md

@@ -2,7 +2,7 @@
 
 This document provides idioms or examples to solve common programming
 problems using streamly. To start with please go through [Streamly Quick
-Overview](/docs/Tutorials/Introduction.md) and [`Streamly examples repository`][streamly-examples].
+Overview](/docs/User/Tutorials/Introduction.md) and [`Streamly examples repository`][streamly-examples].
 This document provides additional examples.
 
 ## Distribute and Zip Concurrently

docs/User/HowTo/streamly-vs-lists.md

@@ -237,7 +237,7 @@ resources compared to streamly. We only show those operations that are at least
 shown in a sorted order, from list's worst performing ones on the left to its
 best ones on the right.
 
-![Streamly vs Lists (time) comparison](/docs/HowTo/streamly-vs-list-time.svg)
+![Streamly vs Lists (time) comparison](/docs/User/HowTo/streamly-vs-list-time.svg)
 
 ## Why use streams instead of lists?
 

docs/User/ProjectRelated/Changelog.md

@@ -48,7 +48,7 @@ See API-changelog.txt for new APIs introduced.
 
 ## 0.8.0 (Jun 2021)
 
-See [API Changelog](/docs/ProjectRelated/API-changelog.txt) for a complete list of signature
+See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of signature
 changes and new APIs introduced.
 
 ### Breaking changes
@@ -87,7 +87,7 @@ changes and new APIs introduced.
 
 ### Enhancements
 
-* See [API Changelog](/docs/ProjectRelated/API-changelog.txt) for a complete list of new
+* See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of new
   modules and APIs introduced.
 * The Fold type is now more powerful, the new termination behavior allows
   to express basic parsing of streams using folds.

docs/User/Tutorials/ConcurrentStreams.hs

@@ -1,6 +1,6 @@
 {-# OPTIONS_GHC -fno-warn-unused-imports #-}
 -- |
--- Module      : Tutorials.ConcurrentStreams
+-- Module      : User.Tutorials.ConcurrentStreams
 -- Copyright   : (c) 2017 Composewell Technologies
 --
 -- License     : BSD3
@@ -10,7 +10,7 @@
 -- declarative concurrent programming.  Before you go through this tutorial we
 -- recommend that you take a look at the Streamly serial streams tutorial.
 
-module Tutorials.ConcurrentStreams
+module User.Tutorials.ConcurrentStreams
     (
     -- * Concurrent Streams
     -- $concurrentStreams

docs/User/Tutorials/Introduction.md

@@ -43,11 +43,11 @@ further reading.
 If you wish to follow along with this guide, you will need to have
 [Streamly][] installed.
 
-Please see the [Getting Started With The Streamly Package](/docs/Tutorials/getting-started.md)
+Please see the [Getting Started With The Streamly Package](/docs/User/Tutorials/getting-started.md)
 guide for instructions on how to install [Streamly][].
 
 If you wish to run benchmarks, please be sure to build your
-application using the instructions in the [Build Guide](/docs/HowTo/Compiling.md).
+application using the instructions in the [Build Guide](/docs/User/HowTo/Compiling.md).
 
 ### An overview of the types used in these examples
 
@@ -595,7 +595,7 @@ significant way:
   * Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))
   * Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))
 
-Please see the [`credits`](/docs/ProjectRelated/Credits.md) directory for a full
+Please see the [`credits`](/docs/User/ProjectRelated/Credits.md) directory for a full
 list of contributors, credits and licenses.
 
 ## Licensing

docs/User/Tutorials/ReactiveProgramming.hs

@@ -1,6 +1,6 @@
 {-# OPTIONS_GHC -fno-warn-unused-imports #-}
 -- |
--- Module      : Tutorials.ReactiveProgramming
+-- Module      : User.Tutorials.ReactiveProgramming
 -- Copyright   : (c) 2017 Composewell Technologies
 --
 -- License     : BSD3
@@ -10,7 +10,7 @@
 -- programming.  Before you go through this tutorial we recommend that you take
 -- a look at the Streamly concurrent programming tutorial.
 
-module Tutorials.ReactiveProgramming
+module User.Tutorials.ReactiveProgramming
     (
     -- * Reactive Programming
     -- $reactive

docs/User/Tutorials/Tutorial.hs

@@ -1,6 +1,6 @@
 {-# OPTIONS_GHC -fno-warn-unused-imports #-}
 -- |
--- Module      : Tutorials.Tutorial
+-- Module      : User.Tutorials.Tutorial
 -- Copyright   : (c) 2017 Composewell Technologies
 --
 -- License     : BSD3
@@ -11,7 +11,7 @@
 -- you take a look at the Streamly Getting Started guide so that you are ready
 -- to try out the examples.
 
-module Tutorials.Tutorial
+module User.Tutorials.Tutorial
     (
     -- * Stream Types
     -- $streams

docs/User/Tutorials/getting-started.md

@@ -279,11 +279,11 @@ streamly][streamly-github] on Github.
 If you got this far successfully, congratulations!
 
 * For an overview of the `streamly` package, please read the
-  [Streamly Quick Overview](/docs/Tutorials/Introduction.md).
+  [Streamly Quick Overview](/docs/User/Tutorials/Introduction.md).
 * Please browse the code examples in the
   [`Streamly examples repository`][streamly-examples].
 * If you would like to start on a real world project, please take a
-  look at the [Streamly Build Guide](/docs/HowTo/Compiling.md).
+  look at the [Streamly Build Guide](/docs/User/HowTo/Compiling.md).
 * For comprehensive documentation please visit the
   [Streamly Homepage][Streamly].
 

docs/streamly-docs.cabal

@@ -16,12 +16,12 @@ build-type:         Simple
 -------------------------------------------------------------------------------
 
 extra-doc-files:
-  Tutorials/*.md
-  HowTo/*.md
-  Explanation/*.md
-  Explanation/streaming-pradigms.rst
-  ProjectRelated/*.md
-  ProjectRelated/Roadmap.link
+  User/Tutorials/*.md
+  User/HowTo/*.md
+  User/Explanation/*.md
+  User/Explanation/streaming-pradigms.rst
+  User/ProjectRelated/*.md
+  User/ProjectRelated/Roadmap.link
   Developer/*.png
   Developer/*.md
   Developer/*.rst
@@ -31,9 +31,9 @@ library
   ghc-options:      -Wall
   hs-source-dirs:    .
   exposed-modules:
-    Tutorials.Tutorial
-    Tutorials.ConcurrentStreams
-    Tutorials.ReactiveProgramming
+    User.Tutorials.Tutorial
+    User.Tutorials.ConcurrentStreams
+    User.Tutorials.ReactiveProgramming
 
   build-depends:
       base              >= 4.9   &&  < 4.17

streamly.cabal

@@ -227,15 +227,15 @@ extra-doc-files:
     docs/Developer/*.png
     docs/Developer/*.md
     docs/Developer/*.rst
-    docs/Tutorials/*.md
-    docs/Tutorials/*.hs
-    docs/HowTo/*.md
-    docs/HowTo/*.svg
-    docs/Explanation/*.md
-    docs/Explanation/streaming-pradigms.rst
-    docs/ProjectRelated/*.md
-    docs/ProjectRelated/Roadmap.link
-    docs/ProjectRelated/API-changelog.txt
+    docs/User/Tutorials/*.md
+    docs/User/Tutorials/*.hs
+    docs/User/HowTo/*.md
+    docs/User/HowTo/*.svg
+    docs/User/Explanation/*.md
+    docs/User/Explanation/streaming-pradigms.rst
+    docs/User/ProjectRelated/*.md
+    docs/User/ProjectRelated/Roadmap.link
+    docs/User/ProjectRelated/API-changelog.txt
     test/README.md
     docs/Developer/Tests.md