a05396c · streamly · git.iko.soy

git.iko.soy/streamly

Move Introduction.md to quick-overview.md

commita05396c16f329af2d21dc9db5b296ed42362d082 authorHarendra Kumar <harendra@composewell.com> dateWed 18 Jan 2023, 10:20 (4 years ago) parenta1d2e1f

7 files changed+6−7

compare with master

unifiedsplit

docs/Developer/Contributing.md+1−2 docs/Developer/MAINTAINING.md+1−1 docs/User/Explanatory/unified-abstractions.md+1−1 docs/User/HowTo/faq.md+1−1 docs/User/ProjectRelated/README.md+1−1 docs/User/Tutorials/Introduction.md → docs/User/Tutorials/quick-overview.md docs/User/Tutorials/setup-and-usage.md+1−1

docs/Developer/Contributing.md+1−2

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

94− updated if necessary.

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

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

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

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

docs/Developer/MAINTAINING.md+1−1

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

142142

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

144144 * Mask out the build status lines from the

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

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

146146 * Upload to hackage

147147 * Use a clean workspace to create source distribution

148148 by freshly cloning the git repository. The reason for

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

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

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

1212

1313## Existing Haskell Libraries

1414

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

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

66This document provides additional examples.

88## Distribute and Zip Concurrently

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

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

1515

1616Please read the [Streamly Setup and Usage

1717Guide](/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

1919library. Streamly comes with comprehensive documentation, please visit

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

2121

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.

212212

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

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

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

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

216216

217217

218218