Commit Graph

38 Commits

Author SHA1 Message Date
Adithya Kumar
5b135b5bfe Symlink a few moved dev files 2022-04-11 01:16:09 +05:30
Adithya Kumar
0c02feae1f Move Contributing doc into the developer documentation 2022-04-11 01:16:09 +05:30
Adithya Kumar
6f3371e656 Move dev/* (developer docs) into docs/Developer/* 2022-04-11 01:16:09 +05:30
Adithya Kumar
1aa7e60256 Fix documentation links 2022-04-11 01:16:09 +05:30
Adithya Kumar
3cdb718b95 Make all the links in md docs absolute to the repo root 2022-02-12 01:20:40 +05:30
Adithya Kumar
d0117d7049 Rephrase some sentences now that the README is moved 2022-02-12 01:20:40 +05:30
Adithya Kumar
d93d5fda8a Move Changelog.md to docs/Changelog.md 2022-02-12 01:20:40 +05:30
Adithya Kumar
8be36018a1 Rename README.md to docs/Introduction.md and fix broken links 2022-02-12 01:20:40 +05:30
Adithya Kumar
8ab2bfd280 Fix broken links in multiple markdown doc files
- README
- docs/unified-abstractions.md
- docs/getting-started.md
- docs/streamly-vs-async.md
- docs/Overview.md
- docs/faq.md
- CONTRIBUTING.md
- benchmark/README.md
2022-02-07 03:56:53 +05:30
Harendra Kumar
f3c31f0385 Add build/test/bench instructions
Move the design related docs out to a separate doc in "dev" dir.
2021-10-12 18:57:14 +05:30
Adithya Kumar
de14835852 Add a "Type variable ordering" section in dev docs 2021-07-30 19:00:38 +05:30
Harendra Kumar
7c5fd94660 Rename the design dir to dev
Now that it hosts all sorts of developer documentation
2021-06-16 19:52:54 +05:30
Harendra Kumar
2e0a445514 Add licensing guidelines 2021-01-01 14:13:35 +05:30
Harendra Kumar
57bd9d29f8 Reorganize some sections 2021-01-01 14:05:26 +05:30
Harendra Kumar
ee3d3a7216 Update and edit PR changeset guidelines 2021-01-01 13:55:30 +05:30
Harendra Kumar
6c27236476 Add fusion/step function guidelines
Add debgugging notes.
2020-11-04 03:13:00 +05:30
Harendra Kumar
fa1bce3951 Add guidelines about performance analysis 2020-07-07 17:05:01 +05:30
Harendra Kumar
91c3b0f8fe Remove coding style section and refer to the guide 2020-05-11 19:29:06 +05:30
Shruti_Umat
3957ceed99 fix output explanation of wAsyncly
typo fix in StreamD coding style
2020-05-04 12:06:31 +05:30
Ahmed Zaheer Dadarkar
e204d9ce09 update to contributing file 2020-05-04 09:42:46 +05:30
Harendra Kumar
750c7fe94a add "where" clause, variable naming, StreamD style 2020-01-13 01:24:49 +05:30
Pranay Sashank
fa7541351a Update Changelog to reflect changes in tap.
- Change `rstState` to `adaptState` in CONTRIBUTING.md.
2019-12-17 13:39:04 +05:30
Brian Wignall
c0a93a4033 Fix some easy-to-make typos 2019-11-26 02:09:15 +05:30
Harendra Kumar
bea83e9610 Update cabal haddock option to generate all docs
Including the ones with "-hide" attribute set.
2019-11-07 18:51:16 +05:30
Harendra Kumar
d0ef2ba1f7 update developer doc generation 2019-07-29 08:30:36 +05:30
Harendra Kumar
58e81952e3 Add pull request checklists 2018-11-05 16:37:46 +05:30
Harendra Kumar
06242af0df Add a README for benchmarks 2018-10-27 14:22:11 +05:30
Harendra Kumar
c39a442ddf Add benchmarks and tests for new operations
Also fix the signature of foldl1'
Add notes about state passing
2018-08-09 00:43:48 +05:30
Harendra Kumar
09c955ea1e use haddock "--show-all" for dev docs 2018-07-11 20:22:56 +05:30
Harendra Kumar
c7b46ad950 Make StreamK, StreamD and Prelude haddock consistent 2018-06-24 23:47:32 +05:30
Harendra Kumar
7831b6711b no imperative mood requirement for changelog 2018-04-05 07:34:34 +05:30
Harendra Kumar
5f5f7c632f Explain Unreleased changelog section 2018-03-14 15:08:31 +05:30
Harendra Kumar
66e30faff7 Document use of imperative mood in changelog 2018-03-14 14:14:34 +05:30
Harendra Kumar
5630e7164b update changelog section 2018-03-14 14:14:34 +05:30
Harendra Kumar
62420fd0c0 Update code organization in contributor's guide 2018-03-12 16:20:30 +05:30
Harendra Kumar
bcf4b0e229 Add define before first use code organization rule 2018-03-12 15:07:41 +05:30
Harendra Kumar
f654d33446 update contributing guide 2018-03-11 20:20:42 +05:30
Harendra Kumar
aa22fba0b7 Add contributors' guide 2018-03-11 18:40:10 +05:30