diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f98ed6c22c..3d290df500 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ 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](benchmark/README.md) * Haddock documentation is added to user visible APIs and data types -* Tutorial module, [README](README.md), and [guides](docs) are updated if +* Tutorial module, [README](docs/Introduction.md), and [guides](docs) are updated if necessary. * [Changelog](Changelog.md) is updated if needed * The code conforms to the license, it is not stolen, credit is given, diff --git a/README.md b/docs/Introduction.md similarity index 98% rename from README.md rename to docs/Introduction.md index 2cacfce9b7..f6901de612 100644 --- a/README.md +++ b/docs/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/getting-started.md) +Please see the [Getting Started With The Streamly Package](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/building.md). +application using the instructions in the [Build Guide](building.md). ### An overview of the types used in these examples @@ -490,7 +490,7 @@ Examples][streamly-examples] web page. * [Streaming Benchmarks][streaming-benchmarks] * [Concurrency Benchmarks][concurrency-benchmarks] * Functional Conf 2019 [Video](https://www.youtube.com/watch?v=uzsqgdMMgtk) | [Slides](https://www.slideshare.net/HarendraKumar10/streamly-concurrent-data-flow-programming) -* [Other Guides](docs/) +* [Other Guides](./) * [Streamly Homepage][Streamly] ## Performance @@ -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/Credits.md) directory for a full +Please see the [`credits`](./Credits.md) directory for a full list of contributors, credits and licenses. ## Licensing @@ -646,6 +646,6 @@ links (for online docs) before we release. [CirclingSquare.hs]: https://github.com/composewell/streamly-examples/tree/master/examples/CirclingSquare.hs -[LICENSE]: LICENSE -[CONTRIBUTING.md]: CONTRIBUTING.md +[LICENSE]: ../LICENSE +[CONTRIBUTING.md]: ../CONTRIBUTING.md [docs]: docs/ diff --git a/docs/faq.md b/docs/faq.md index 86ff4507af..51f06096f6 100644 --- a/docs/faq.md +++ b/docs/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](../README.md) and [`Streamly examples repository`][streamly-examples]. +Overview](./Introduction.md) and [`Streamly examples repository`][streamly-examples]. This document provides additional examples. ## Distribute and Zip Concurrently diff --git a/docs/getting-started.md b/docs/getting-started.md index 0ec4d7be87..0f75e5b974 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -279,7 +279,7 @@ 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](../README.md). + [Streamly Quick Overview](./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 diff --git a/docs/unified-abstractions.md b/docs/unified-abstractions.md index 6827860ce2..4d181bcc87 100644 --- a/docs/unified-abstractions.md +++ b/docs/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](../README.md) document. +library please see the [Streamly Quick Overview](./Introduction.md) document. ## Existing Haskell Libraries