cadd57c · streamly · git.iko.soy

git.iko.soy/streamly

Move user documentation under the User node

commitcadd57ca19c65b96e61729cef54e3020cecacbc5 authorAdithya Kumar <adithya@composewell.com> dateSat 9 Apr 2022, 13:26 (5 years ago) parent5b135b5

27 files changed+40−40

compare with master

unifiedsplit

docs/Developer/Contributing.md+2−2 docs/Developer/MAINTAINING.md+1−1 docs/Explanation/Overview.md → docs/User/Explanation/Overview.md+1−1 docs/Explanation/monad-transformers.md → docs/User/Explanation/monad-transformers.md docs/Explanation/streaming-pradigms.rst → docs/User/Explanation/streaming-pradigms.rst docs/Explanation/unified-abstractions.md → docs/User/Explanation/unified-abstractions.md+3−3 docs/HowTo/Compiling.md → docs/User/HowTo/Compiling.md docs/HowTo/faq.md → docs/User/HowTo/faq.md+1−1 docs/HowTo/interoperation.md → docs/User/HowTo/interoperation.md docs/HowTo/optimizing.md → docs/User/HowTo/optimizing.md docs/HowTo/streamly-vs-async.md → docs/User/HowTo/streamly-vs-async.md docs/HowTo/streamly-vs-list-time.svg → docs/User/HowTo/streamly-vs-list-time.svg docs/HowTo/streamly-vs-lists.md → docs/User/HowTo/streamly-vs-lists.md+1−1 docs/ProjectRelated/API-changelog.txt → docs/User/ProjectRelated/API-changelog.txt docs/ProjectRelated/CONTRIBUTORS.md → docs/User/ProjectRelated/CONTRIBUTORS.md docs/ProjectRelated/Changelog.md → docs/User/ProjectRelated/Changelog.md+2−2 docs/ProjectRelated/Credits.md → docs/User/ProjectRelated/Credits.md docs/ProjectRelated/Roadmap.link → docs/User/ProjectRelated/Roadmap.link docs/ProjectRelated/performance.md → docs/User/ProjectRelated/performance.md docs/ProjectRelated/resources.md → docs/User/ProjectRelated/resources.md docs/Tutorials/ConcurrentStreams.hs → docs/User/Tutorials/ConcurrentStreams.hs+2−2 docs/Tutorials/Introduction.md → docs/User/Tutorials/Introduction.md+3−3 docs/Tutorials/ReactiveProgramming.hs → docs/User/Tutorials/ReactiveProgramming.hs+2−2 docs/Tutorials/Tutorial.hs → docs/User/Tutorials/Tutorial.hs+2−2 docs/Tutorials/getting-started.md → docs/User/Tutorials/getting-started.md+2−2 docs/streamly-docs.cabal+9−9 streamly.cabal+9−9

docs/Developer/Contributing.md+2−2

@@ -90,9 +90,9 @@ Here is a quick checklist for a PR, for details please see the next section:

9090* [Performance benchmarks](/benchmark) are added, where applicable

9191* No significant regressions are reported by [performance benchmarks](/docs/Developer/Benchmarks.md)

9292* Haddock documentation is added to user visible APIs and data types

93−* Tutorial module, [Introduction](/docs/Tutorials/Introduction.md), and [guides](/docs) are

93+* Tutorial module, [Introduction](/docs/User/Tutorials/Introduction.md), and [guides](/docs) are

9494 updated if necessary.

95−* [Changelog](/docs/ProjectRelated/Changelog.md) is updated if needed

95+* [Changelog](/docs/User/ProjectRelated/Changelog.md) is updated if needed

9696* The code conforms to the license, it is not stolen, credit is given,

9797 copyright notices are retained, original license is included if needed.

9898

docs/Developer/MAINTAINING.md+1−1

@@ -138,7 +138,7 @@

138138 * Wait for final CI tests to pass:

139139

140140 * Mask out the build status lines from the

141− [docs/Introduction.md](/docs/Tutorials/Introduction.md)

141+ [docs/Introduction.md](/docs/User/Tutorials/Introduction.md)

142142 * Upload to hackage

143143 * Use a clean workspace to create source distribution

144144 by freshly cloning the git repository. The reason for

docs/Explanation/Overview.md → docs/User/Explanation/Overview.mdrenamed+1−1

@@ -95,7 +95,7 @@ can be constructed from monadic effects, not just pure elements. Streams are

9595processed just like lists, with list like combinators, except that they are

9696monadic and work in a streaming fashion. In other words streamly just completes

9797what lists lack, you do not need to learn anything new. Please see [streamly vs

98−lists](/docs/HowTo/streamly-vs-lists.md) for a detailed comparison.

98+lists](/docs/User/HowTo/streamly-vs-lists.md) for a detailed comparison.

9999

100100Not surprisingly, the monad instance of streamly is a list transformer, with

101101concurrency capability.

docs/Explanation/monad-transformers.md → docs/User/Explanation/monad-transformers.mdrenamed

The content is the same.

docs/Explanation/streaming-pradigms.rst → docs/User/Explanation/streaming-pradigms.rstrenamed

The content is the same.

docs/Explanation/unified-abstractions.md → docs/User/Explanation/unified-abstractions.mdrenamed+3−3

@@ -8,7 +8,7 @@ ecosystem.

88This document discusses the related packages in the Haskell ecosystem

99and how streamly unifies, overlaps, or compares with those. We provide

1010simple code snippets for illustrations, for a better overview of the

11−library please see the [Streamly Quick Overview](/docs/Tutorials/Introduction.md) document.

11+library please see the [Streamly Quick Overview](/docs/User/Tutorials/Introduction.md) document.

1212

1313## Existing Haskell Libraries

1414

@@ -94,7 +94,7 @@ uses a vector-like stream representation which is amenable to

9494low-level code having performance comparable to C.

9595

9696To further understand the similarity with list API, please see [Streamly vs.

97−lists](/docs/HowTo/streamly-vs-lists.md).

97+lists](/docs/User/HowTo/streamly-vs-lists.md).

9898For comparison of Streamly performance with other libraries see

9999[streaming benchmarks](https://github.com/composewell/streaming-benchmarks).

100100

@@ -161,7 +161,7 @@ The same combinators that are used for serial streams e.g. 'unfoldrM',

161161'replicateM', 'repeatM' work concurrently when used at the appropriate type.

162162It allows concurrent programs to be written declaratively and composed

163163idiomatically. They are not much different than serial programs. See

164−[Streamly vs async](/docs/HowTo/streamly-vs-async.md)

164+[Streamly vs async](/docs/User/HowTo/streamly-vs-async.md)

165165for a comparison of Streamly with the `async` package.

166166

167167Streamly provides concurrent scheduling and looping similar to to

docs/HowTo/Compiling.md → docs/User/HowTo/Compiling.mdrenamed

The content is the same.

docs/HowTo/faq.md → docs/User/HowTo/faq.mdrenamed+1−1

@@ -2,7 +2,7 @@

33This document provides idioms or examples to solve common programming

44problems using streamly. To start with please go through [Streamly Quick

5−Overview](/docs/Tutorials/Introduction.md) and [`Streamly examples repository`][streamly-examples].

5+Overview](/docs/User/Tutorials/Introduction.md) and [`Streamly examples repository`][streamly-examples].

66This document provides additional examples.

88## Distribute and Zip Concurrently

docs/HowTo/interoperation.md → docs/User/HowTo/interoperation.mdrenamed

The content is the same.

docs/HowTo/optimizing.md → docs/User/HowTo/optimizing.mdrenamed

The content is the same.

docs/HowTo/streamly-vs-async.md → docs/User/HowTo/streamly-vs-async.mdrenamed

The content is the same.

docs/HowTo/streamly-vs-list-time.svg → docs/User/HowTo/streamly-vs-list-time.svgrenamed

The content is the same.

docs/HowTo/streamly-vs-lists.md → docs/User/HowTo/streamly-vs-lists.mdrenamed+1−1

@@ -237,7 +237,7 @@ resources compared to streamly. We only show those operations that are at least

237237shown in a sorted order, from list's worst performing ones on the left to its

238238best ones on the right.

239239

240−![Streamly vs Lists (time) comparison](/docs/HowTo/streamly-vs-list-time.svg)

240+![Streamly vs Lists (time) comparison](/docs/User/HowTo/streamly-vs-list-time.svg)

241241

242242## Why use streams instead of lists?

243243

docs/ProjectRelated/API-changelog.txt → docs/User/ProjectRelated/API-changelog.txtrenamed

The content is the same.

docs/ProjectRelated/CONTRIBUTORS.md → docs/User/ProjectRelated/CONTRIBUTORS.mdrenamed

The content is the same.

docs/ProjectRelated/Changelog.md → docs/User/ProjectRelated/Changelog.mdrenamed+2−2

@@ -48,7 +48,7 @@ See API-changelog.txt for new APIs introduced.

4848

4949## 0.8.0 (Jun 2021)

5050

51−See [API Changelog](/docs/ProjectRelated/API-changelog.txt) for a complete list of signature

51+See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of signature

5252changes and new APIs introduced.

5353

5454### Breaking changes

@@ -87,7 +87,7 @@ changes and new APIs introduced.

8787

8888### Enhancements

8989

90−* See [API Changelog](/docs/ProjectRelated/API-changelog.txt) for a complete list of new

90+* See [API Changelog](/docs/User/ProjectRelated/API-changelog.txt) for a complete list of new

9191 modules and APIs introduced.

9292* The Fold type is now more powerful, the new termination behavior allows

9393 to express basic parsing of streams using folds.

docs/ProjectRelated/Credits.md → docs/User/ProjectRelated/Credits.mdrenamed

The content is the same.

docs/ProjectRelated/Roadmap.link → docs/User/ProjectRelated/Roadmap.linkrenamed

The content is the same.

docs/ProjectRelated/performance.md → docs/User/ProjectRelated/performance.mdrenamed

The content is the same.

docs/ProjectRelated/resources.md → docs/User/ProjectRelated/resources.mdrenamed

The content is the same.

docs/Tutorials/ConcurrentStreams.hs → docs/User/Tutorials/ConcurrentStreams.hsrenamed+2−2

@@ -1,6 +1,6 @@

11{-# OPTIONS_GHC -fno-warn-unused-imports #-}

22-- |

3−-- Module : Tutorials.ConcurrentStreams

3+-- Module : User.Tutorials.ConcurrentStreams

55--

66-- License : BSD3

@@ -10,7 +10,7 @@

1010-- declarative concurrent programming. Before you go through this tutorial we

1111-- recommend that you take a look at the Streamly serial streams tutorial.

1212

13−module Tutorials.ConcurrentStreams

13+module User.Tutorials.ConcurrentStreams

1414 (

1515 -- * Concurrent Streams

1616 -- $concurrentStreams

docs/Tutorials/Introduction.md → docs/User/Tutorials/Introduction.mdrenamed+3−3

@@ -43,11 +43,11 @@ further reading.

4343If you wish to follow along with this guide, you will need to have

4444[Streamly][] installed.

4545

46−Please see the [Getting Started With The Streamly Package](/docs/Tutorials/getting-started.md)

46+Please see the [Getting Started With The Streamly Package](/docs/User/Tutorials/getting-started.md)

4747guide for instructions on how to install [Streamly][].

4848

4949If you wish to run benchmarks, please be sure to build your

50−application using the instructions in the [Build Guide](/docs/HowTo/Compiling.md).

50+application using the instructions in the [Build Guide](/docs/User/HowTo/Compiling.md).

5151

5252### An overview of the types used in these examples

5353

@@ -595,7 +595,7 @@ significant way:

595595 * Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))

596596 * Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))

597597

598−Please see the [`credits`](/docs/ProjectRelated/Credits.md) directory for a full

598+Please see the [`credits`](/docs/User/ProjectRelated/Credits.md) directory for a full

599599list of contributors, credits and licenses.

600600

601601## Licensing

docs/Tutorials/ReactiveProgramming.hs → docs/User/Tutorials/ReactiveProgramming.hsrenamed+2−2

@@ -1,6 +1,6 @@

11{-# OPTIONS_GHC -fno-warn-unused-imports #-}

22-- |

3−-- Module : Tutorials.ReactiveProgramming

3+-- Module : User.Tutorials.ReactiveProgramming

55--

66-- License : BSD3

@@ -10,7 +10,7 @@

1010-- programming. Before you go through this tutorial we recommend that you take

1111-- a look at the Streamly concurrent programming tutorial.

1212

13−module Tutorials.ReactiveProgramming

13+module User.Tutorials.ReactiveProgramming

1414 (

1515 -- * Reactive Programming

1616 -- $reactive

docs/Tutorials/Tutorial.hs → docs/User/Tutorials/Tutorial.hsrenamed+2−2

@@ -1,6 +1,6 @@

11{-# OPTIONS_GHC -fno-warn-unused-imports #-}

22-- |

3−-- Module : Tutorials.Tutorial

3+-- Module : User.Tutorials.Tutorial

55--

66-- License : BSD3

@@ -11,7 +11,7 @@

1111-- you take a look at the Streamly Getting Started guide so that you are ready

1212-- to try out the examples.

1313

14−module Tutorials.Tutorial

14+module User.Tutorials.Tutorial

1515 (

1616 -- * Stream Types

1717 -- $streams

docs/Tutorials/getting-started.md → docs/User/Tutorials/getting-started.mdrenamed+2−2

@@ -279,11 +279,11 @@ streamly][streamly-github] on Github.

279279If you got this far successfully, congratulations!

280280

281281* For an overview of the `streamly` package, please read the

282− [Streamly Quick Overview](/docs/Tutorials/Introduction.md).

282+ [Streamly Quick Overview](/docs/User/Tutorials/Introduction.md).

283283* Please browse the code examples in the

284284 [`Streamly examples repository`][streamly-examples].

285285* If you would like to start on a real world project, please take a

286− look at the [Streamly Build Guide](/docs/HowTo/Compiling.md).

286+ look at the [Streamly Build Guide](/docs/User/HowTo/Compiling.md).

287287* For comprehensive documentation please visit the

288288 [Streamly Homepage][Streamly].

289289

docs/streamly-docs.cabal+9−9

@@ -16,12 +16,12 @@ build-type: Simple

1616-------------------------------------------------------------------------------

1717

1818extra-doc-files:

19− Tutorials/*.md

20− HowTo/*.md

21− Explanation/*.md

22− Explanation/streaming-pradigms.rst

23− ProjectRelated/*.md

24− ProjectRelated/Roadmap.link

19+ User/Tutorials/*.md

20+ User/HowTo/*.md

21+ User/Explanation/*.md

22+ User/Explanation/streaming-pradigms.rst

23+ User/ProjectRelated/*.md

24+ User/ProjectRelated/Roadmap.link

2525 Developer/*.png

2626 Developer/*.md

2727 Developer/*.rst

@@ -31,9 +31,9 @@ library

3131 ghc-options: -Wall

3232 hs-source-dirs: .

3333 exposed-modules:

34− Tutorials.Tutorial

35− Tutorials.ConcurrentStreams

36− Tutorials.ReactiveProgramming

34+ User.Tutorials.Tutorial

35+ User.Tutorials.ConcurrentStreams

36+ User.Tutorials.ReactiveProgramming

3737

3838 build-depends:

3939 base >= 4.9 && < 4.17

streamly.cabal+9−9

@@ -227,15 +227,15 @@ extra-doc-files:

227227 docs/Developer/*.png

228228 docs/Developer/*.md

229229 docs/Developer/*.rst

230− docs/Tutorials/*.md

231− docs/Tutorials/*.hs

232− docs/HowTo/*.md

233− docs/HowTo/*.svg

234− docs/Explanation/*.md

235− docs/Explanation/streaming-pradigms.rst

236− docs/ProjectRelated/*.md

237− docs/ProjectRelated/Roadmap.link

238− docs/ProjectRelated/API-changelog.txt

230+ docs/User/Tutorials/*.md

231+ docs/User/Tutorials/*.hs

232+ docs/User/HowTo/*.md

233+ docs/User/HowTo/*.svg

234+ docs/User/Explanation/*.md

235+ docs/User/Explanation/streaming-pradigms.rst

236+ docs/User/ProjectRelated/*.md

237+ docs/User/ProjectRelated/Roadmap.link

238+ docs/User/ProjectRelated/API-changelog.txt

239239 test/README.md

240240 docs/Developer/Tests.md

241241