Categorize documentation in a better way
commite32bccdffa07441ca3e0087154b91f76c732f56c
authorAdithya Kumar <adithya@composewell.com>
dateTue 29 Mar 2022, 03:27 (5 years ago)
parent800ae8a
docs/Overview.md → docs/Explanation/Overview.mdrenamed
The content is the same.
docs/monad-transformers.md → docs/Explanation/monad-transformers.mdrenamed
The content is the same.
docs/streaming-pradigms.rst → docs/Explanation/streaming-pradigms.rstrenamed
The content is the same.
docs/unified-abstractions.md → docs/Explanation/unified-abstractions.mdrenamed
The content is the same.
docs/Compiling.md → docs/HowTo/Compiling.mdrenamed
The content is the same.
docs/faq.md → docs/HowTo/faq.mdrenamed
The content is the same.
docs/interoperation.md → docs/HowTo/interoperation.mdrenamed
The content is the same.
docs/optimizing.md → docs/HowTo/optimizing.mdrenamed
The content is the same.
docs/streamly-vs-async.md → docs/HowTo/streamly-vs-async.mdrenamed
The content is the same.
docs/streamly-vs-list-time.svg → docs/HowTo/streamly-vs-list-time.svgrenamed
The content is the same.
docs/streamly-vs-lists.md → docs/HowTo/streamly-vs-lists.mdrenamed
The content is the same.
docs/API-changelog.txt → docs/ProjectRelated/API-changelog.txtrenamed
The content is the same.
docs/CONTRIBUTORS.md → docs/ProjectRelated/CONTRIBUTORS.mdrenamed
The content is the same.
docs/Changelog.md → docs/ProjectRelated/Changelog.mdrenamed
The content is the same.
docs/Credits.md → docs/ProjectRelated/Credits.mdrenamed
The content is the same.
docs/Roadmap.link → docs/ProjectRelated/Roadmap.linkrenamed
The content is the same.
docs/performance.md → docs/ProjectRelated/performance.mdrenamed
The content is the same.
docs/resources.md → docs/ProjectRelated/resources.mdrenamed
The content is the same.
docs/ConcurrentStreams.hs → docs/Tutorials/ConcurrentStreams.hsrenamed+2−2
@@ -1,6 +1,6 @@
11{-# OPTIONS_GHC -fno-warn-unused-imports #-}
22-- |
3−-- Module : ConcurrentStreams
3+-- Module : Tutorials.ConcurrentStreams
44-- Copyright : (c) 2017 Composewell Technologies
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 ConcurrentStreams
13+module Tutorials.ConcurrentStreams
1414 (
1515 -- * Concurrent Streams
1616 -- $concurrentStreams
docs/Introduction.md → docs/Tutorials/Introduction.mdrenamed
The content is the same.
docs/ReactiveProgramming.hs → docs/Tutorials/ReactiveProgramming.hsrenamed+2−2
@@ -1,6 +1,6 @@
11{-# OPTIONS_GHC -fno-warn-unused-imports #-}
22-- |
3−-- Module : ReactiveProgramming
3+-- Module : Tutorials.ReactiveProgramming
44-- Copyright : (c) 2017 Composewell Technologies
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 ReactiveProgramming
13+module Tutorials.ReactiveProgramming
1414 (
1515 -- * Reactive Programming
1616 -- $reactive
docs/Tutorial.hs → docs/Tutorials/Tutorial.hsrenamed+2−2
@@ -1,6 +1,6 @@
11{-# OPTIONS_GHC -fno-warn-unused-imports #-}
22-- |
3−-- Module : Tutorial
3+-- Module : Tutorials.Tutorial
44-- Copyright : (c) 2017 Composewell Technologies
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 Tutorial
14+module Tutorials.Tutorial
1515 (
1616 -- * Stream Types
1717 -- $streams
docs/getting-started.md → docs/Tutorials/getting-started.mdrenamed
The content is the same.
docs/streamly-docs.cabal+9−5
@@ -16,17 +16,21 @@ build-type: Simple
1616-------------------------------------------------------------------------------
1717
1818extra-doc-files:
19− Roadmap.link
20− *.md
19+ Tutorials/*.md
20+ HowTo/*.md
21+ Explanation/*.md
22+ Explanation/streaming-pradigms.rst
23+ ProjectRelated/*.md
24+ ProjectRelated/Roadmap.link
2125
2226library
2327 default-language: Haskell2010
2428 ghc-options: -Wall
2529 hs-source-dirs: .
2630 exposed-modules:
27− Tutorial
28− ConcurrentStreams
29− ReactiveProgramming
31+ Tutorials.Tutorial
32+ Tutorials.ConcurrentStreams
33+ Tutorials.ReactiveProgramming
3034
3135 build-depends:
3236 base >= 4.9 && < 4.17
streamly.cabal+9−5
@@ -223,11 +223,15 @@ extra-doc-files:
223223 dev/*.md
224224 dev/*.png
225225 dev/*.rst
226− docs/*.md
227− docs/*.link
228− docs/*.rst
229− docs/*.svg
230− docs/API-changelog.txt
226+ docs/Tutorials/*.md
227+ docs/Tutorials/*.hs
228+ docs/HowTo/*.md
229+ docs/HowTo/*.svg
230+ docs/Explanation/*.md
231+ docs/Explanation/streaming-pradigms.rst
232+ docs/ProjectRelated/*.md
233+ docs/ProjectRelated/Roadmap.link
234+ docs/ProjectRelated/API-changelog.txt
231235 test/README.md
232236
233237extra-tmp-files: