cadd57c · streamly · git.iko.soy

docs/Developer/Contributing.md+2−2

compare with master

unifiedsplit

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

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

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

92* 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

94 updated if necessary.

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

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

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

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

98

docs/Developer/MAINTAINING.md+1−1

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

138 * Wait for final CI tests to pass:

139

140 * 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)

142 * Upload to hackage

143 * Use a clean workspace to create source distribution

144 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

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

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

97what 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.

99

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

101concurrency 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.

8This document discusses the related packages in the Haskell ecosystem

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

10simple 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.

12

13## Existing Haskell Libraries

14

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

94low-level code having performance comparable to C.

95

96To 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).

98For comparison of Streamly performance with other libraries see

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

100

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

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

162It allows concurrent programs to be written declaratively and composed

163idiomatically. 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)

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

166

167Streamly 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 @@

2

3This document provides idioms or examples to solve common programming

4problems 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].

6This document provides additional examples.

7

8## 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

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

238best ones on the right.

239

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)

241

242## Why use streams instead of lists?

243

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.

48

49## 0.8.0 (Jun 2021)

50

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

52changes and new APIs introduced.

53

54### Breaking changes

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

87

88### Enhancements

89

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

91 modules and APIs introduced.

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

93 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 @@

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

2-- |

3−-- Module : Tutorials.ConcurrentStreams

3+-- Module : User.Tutorials.ConcurrentStreams

5--

6-- License : BSD3

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

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

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

12

13−module Tutorials.ConcurrentStreams

13+module User.Tutorials.ConcurrentStreams

14 (

15 -- * Concurrent Streams

16 -- $concurrentStreams

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

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

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

44[Streamly][] installed.

45

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)

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

48

49If 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).

51

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

53

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

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

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

597

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

599list of contributors, credits and licenses.

600

601## Licensing

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

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

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

2-- |

3−-- Module : Tutorials.ReactiveProgramming

3+-- Module : User.Tutorials.ReactiveProgramming

5--

6-- License : BSD3

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

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

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

12

13−module Tutorials.ReactiveProgramming

13+module User.Tutorials.ReactiveProgramming

14 (

15 -- * Reactive Programming

16 -- $reactive

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

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

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

2-- |

3−-- Module : Tutorials.Tutorial

3+-- Module : User.Tutorials.Tutorial

5--

6-- License : BSD3

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

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

12-- to try out the examples.

13

14−module Tutorials.Tutorial

14+module User.Tutorials.Tutorial

15 (

16 -- * Stream Types

17 -- $streams

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

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

279If you got this far successfully, congratulations!

280

281* 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).

283* Please browse the code examples in the

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

285* 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).

287* For comprehensive documentation please visit the

288 [Streamly Homepage][Streamly].

289

docs/streamly-docs.cabal+9−9

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

16-------------------------------------------------------------------------------

17

18extra-doc-files:

19− Tutorials/*.md

19+ User/Tutorials/*.md

20− HowTo/*.md

20+ User/HowTo/*.md

21− Explanation/*.md

21+ User/Explanation/*.md

22− Explanation/streaming-pradigms.rst

22+ User/Explanation/streaming-pradigms.rst

23− ProjectRelated/*.md

23+ User/ProjectRelated/*.md

24− ProjectRelated/Roadmap.link

24+ User/ProjectRelated/Roadmap.link

25 Developer/*.png

26 Developer/*.md

27 Developer/*.rst

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

31 ghc-options: -Wall

32 hs-source-dirs: .

33 exposed-modules:

34− Tutorials.Tutorial

34+ User.Tutorials.Tutorial

35− Tutorials.ConcurrentStreams

35+ User.Tutorials.ConcurrentStreams

36− Tutorials.ReactiveProgramming

36+ User.Tutorials.ReactiveProgramming

37

38 build-depends:

39 base >= 4.9 && < 4.17

streamly.cabal+9−9

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

227 docs/Developer/*.png

228 docs/Developer/*.md

229 docs/Developer/*.rst

230− docs/Tutorials/*.md

230+ docs/User/Tutorials/*.md

231− docs/Tutorials/*.hs

231+ docs/User/Tutorials/*.hs

232− docs/HowTo/*.md

232+ docs/User/HowTo/*.md

233− docs/HowTo/*.svg

233+ docs/User/HowTo/*.svg

234− docs/Explanation/*.md

234+ docs/User/Explanation/*.md

235− docs/Explanation/streaming-pradigms.rst

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

236− docs/ProjectRelated/*.md

236+ docs/User/ProjectRelated/*.md

237− docs/ProjectRelated/Roadmap.link

237+ docs/User/ProjectRelated/Roadmap.link

238− docs/ProjectRelated/API-changelog.txt

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

239 test/README.md

240 docs/Developer/Tests.md

241