Rename the design dir to dev
Now that it hosts all sorts of developer documentation
commit7c5fd9466085307bfb283fab76f15f69c15fdf0d
authorHarendra Kumar <harendra@composewell.com>
dateWed 16 Jun 2021, 18:31 (5 years ago)
parent96bf71e
CONTRIBUTING.md+5−4
@@ -182,15 +182,16 @@ copying does not have an associated license please do not use it.
182182
183183## Developer documentation
184184
185−To build haddock documentation for all modules, including the ones not exposed
186−to users of the library, use the following commands:
185+To build haddock documentation:
187186
188187```
189188$ cabal haddock
190−$ stack haddock --no-haddock-deps
191189```
192190
193−For design documentation see the `design` directory.
191+Open the link printed at the end of the output of this command, in
192+your browser.
193+
194+For general library developer documentation see the `dev` directory.
194195
195196## Coding Guidelines
196197
design/ci-tests.md → dev/ci-tests.mdrenamed
The content is the same.
design/container-api.md → dev/container-api.mdrenamed
The content is the same.
design/cps-vs-direct.rst → dev/cps-vs-direct.rstrenamed
The content is the same.
design/dfa-bytes.png → dev/dfa-bytes.pngrenamed
Binary file not shown.
design/dfa-classes.png → dev/dfa-classes.pngrenamed
Binary file not shown.
design/dfa-rearr.png → dev/dfa-rearr.pngrenamed
Binary file not shown.
design/linked-lists.md → dev/linked-lists.mdrenamed
The content is the same.
design/module-organization.md → dev/module-organization.mdrenamed
The content is the same.
design/optimization-guidelines.md → dev/optimization-guidelines.mdrenamed
The content is the same.
design/paths.rst → dev/paths.rstrenamed
The content is the same.
design/related-packages.md → dev/related-packages.mdrenamed
The content is the same.
design/resources.md → dev/resources.mdrenamed
The content is the same.
design/roadmap.md → dev/roadmap.mdrenamed
The content is the same.
design/unicode.md → dev/unicode.mdrenamed
The content is the same.
design/utf8-decoder.md → dev/utf8-decoder.mdrenamed
The content is the same.
streamly.cabal+3−3
@@ -97,9 +97,9 @@ extra-source-files:
9797 credits/transient-0.5.5.txt
9898 credits/vector-0.12.0.2.txt
9999 default.nix
100− design/*.md
101− design/*.png
102− design/*.rst
100+ dev/*.md
101+ dev/*.png
102+ dev/*.rst
103103 docs/*.md
104104 docs/*.hs
105105 docs/*.svg