a05396c · streamly · git.iko.soy

docs/Developer/Contributing.md+1−2

compare with master

unifiedsplit

@@ -90,8 +90,7 @@ 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/User/Tutorials/Introduction.md), and [guides](/docs) are

94− updated if necessary.

93+* [Docs](/docs) are updated if necessary.

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

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

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

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

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

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

docs/Developer/MAINTAINING.md+1−1

@@ -142,7 +142,7 @@

142

143 * Manually run packcheck for ghcjs, `bin/run-ci.sh --targets ghcjs`.

144 * Mask out the build status lines from the

145− [docs/Introduction.md](/docs/User/Tutorials/Introduction.md)

145+ [README](/docs/User/ProjectRelated/README.md)

146 * Upload to hackage

147 * Use a clean workspace to create source distribution

148 by freshly cloning the git repository. The reason for

docs/User/Explanatory/unified-abstractions.md+1−1

@@ -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/User/Tutorials/Introduction.md) document.

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

12

13## Existing Haskell Libraries

14

docs/User/HowTo/faq.md+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/User/Tutorials/Introduction.md) and [`Streamly examples repository`][streamly-examples].

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

6This document provides additional examples.

7

8## Distribute and Zip Concurrently

docs/User/ProjectRelated/README.md+1−1

@@ -15,7 +15,7 @@ safe, scalable, modular and high performance software. Streamly offers:

15

16Please read the [Streamly Setup and Usage

17Guide](/docs/User/Tutorials/setup-and-usage.md) and [Streamly Quick

18−Tutorial](/docs/User/Tutorials/Introduction.md) to get a taste of the

18+Overview](/docs/User/Tutorials/quick-overview.md) to get a taste of the

19library. Streamly comes with comprehensive documentation, please visit

20the [Haskell Streamly website][Streamly] for documentation.

21

docs/User/Tutorials/Introduction.md → docs/User/Tutorials/quick-overview.mdrenamed

The content is the same.

docs/User/Tutorials/setup-and-usage.md+1−1

@@ -212,7 +212,7 @@ streamly][streamly-github] from Github.

212

213If you got this far successfully, congratulations! For an overview

214of the `streamly` package, please read the [Streamly Quick

215−Overview](/docs/User/Tutorials/Introduction.md).

215+Overview](/docs/User/Tutorials/quick-overview.md).

216

217

218