git.iko.soy/streamly
on master help sign in
Move dev/* (developer docs) into docs/Developer/*
6f3371eAdithya Kumar
CONTRIBUTING.md+1−1
compare with master
unifiedsplit
@@ -222,7 +222,7 @@ copying does not have an associated license please do not use it.
222
222
223* Use https://streamly.composewell.com/ for searching in reference docs
223* Use https://streamly.composewell.com/ for searching in reference docs
224* Build haddock docs for latest reference docs
224* Build haddock docs for latest reference docs
225−* See [the dev directory](/dev) for design guidelines and dev documents.
225+* See [the dev directory](/docs/Developer) for design guidelines and dev documents.
226
226
227## Coding Guidelines
227## Coding Guidelines
228
228
benchmark/README.md+1−1
@@ -310,7 +310,7 @@ they are usually annotated so in their documentation.
310### Resolving the problem
310### Resolving the problem
311
311
312Review the problematic code, see [the optimization
312Review the problematic code, see [the optimization
313−guide](/dev/optimization-guidelines.md) for common problems and how to
313+guide](/docs/Developer/optimization-guidelines.md) for common problems and how to
314solve those. If no obvious issues are found on review, then generate and
314solve those. If no obvious issues are found on review, then generate and
315examine the core.
315examine the core.
316
316
dev/MAINTAINING.md → docs/Developer/MAINTAINING.mdrenamed

The content is the same.

dev/ci-tests.md → docs/Developer/ci-tests.mdrenamed

The content is the same.

dev/container-api.md → docs/Developer/container-api.mdrenamed

The content is the same.

dev/cps-vs-direct.rst → docs/Developer/cps-vs-direct.rstrenamed

The content is the same.

dev/dfa-bytes.png → docs/Developer/dfa-bytes.pngrenamed

Binary file not shown.

dev/dfa-classes.png → docs/Developer/dfa-classes.pngrenamed

Binary file not shown.

dev/dfa-rearr.png → docs/Developer/dfa-rearr.pngrenamed

Binary file not shown.

dev/linked-lists.md → docs/Developer/linked-lists.mdrenamed

The content is the same.

dev/module-organization.md → docs/Developer/module-organization.mdrenamed

The content is the same.

dev/optimization-guidelines.md → docs/Developer/optimization-guidelines.mdrenamed

The content is the same.

dev/overview.md → docs/Developer/overview.mdrenamed

The content is the same.

dev/paths.rst → docs/Developer/paths.rstrenamed

The content is the same.

dev/related-packages.md → docs/Developer/related-packages.mdrenamed

The content is the same.

dev/resources.md → docs/Developer/resources.mdrenamed

The content is the same.

dev/roadmap.md → docs/Developer/roadmap.mdrenamed

The content is the same.

dev/unicode.md → docs/Developer/unicode.mdrenamed

The content is the same.

dev/utf8-decoder.md → docs/Developer/utf8-decoder.mdrenamed+3−3
@@ -263,7 +263,7 @@ back to it, we\'ve seen a whole Unicode character. Transitions not in
263the graph are disallowed; they all lead to state one, which has been
263the graph are disallowed; they all lead to state one, which has been
264omitted for readability.
264omitted for readability.
265
265
266−![DFA with range transitions](/dev/dfa-bytes.png)
266+![DFA with range transitions](/docs/Developer/dfa-bytes.png)
267
267
268### Automaton with character class transitions
268### Automaton with character class transitions
269
269
@@ -273,7 +273,7 @@ encoding the ranges directly, the ranges are split such that each byte
273belongs to exactly one character class. Then the transitions go over
273belongs to exactly one character class. Then the transitions go over
274these character classes.
274these character classes.
275
275
276−![DFA with class transitions](/dev/dfa-classes.png)
276+![DFA with class transitions](/docs/Developer/dfa-classes.png)
277
277
278### Mapping bytes to character classes
278### Mapping bytes to character classes
279
279
@@ -404,7 +404,7 @@ the non-ASCII starter is swapped (approximately a 5% increase), but GCC
404I have experimented with various rearrangements of states and character
404I have experimented with various rearrangements of states and character
405classes. A seemingly promising one is the following:
405classes. A seemingly promising one is the following:
406
406
407−![Re-arranged DFA with class transitions](/dev/dfa-rearr.png)
407+![Re-arranged DFA with class transitions](/docs/Developer/dfa-rearr.png)
408
408
409One of the continuation ranges has been split into two, the other
409One of the continuation ranges has been split into two, the other
410changes are just renamings. This arrangement allows, when a continuation
410changes are just renamings. This arrangement allows, when a continuation
docs/streamly-docs.cabal+3
@@ -22,6 +22,9 @@ extra-doc-files:
22 Explanation/streaming-pradigms.rst
22 Explanation/streaming-pradigms.rst
23 ProjectRelated/*.md
23 ProjectRelated/*.md
24 ProjectRelated/Roadmap.link
24 ProjectRelated/Roadmap.link
25+ Developer/*.png
26+ Developer/*.md
27+ Developer/*.rst
25
28
26library
29library
27 default-language: Haskell2010
30 default-language: Haskell2010
streamly.cabal+6−3
@@ -220,9 +220,12 @@ extra-doc-files:
220 CHANGELOG.md
220 CHANGELOG.md
221 README.md
221 README.md
222 benchmark/README.md
222 benchmark/README.md
223− dev/*.md
223+ docs/Developer/*.png
224− dev/*.png
224+ docs/Developer/*.md
225− dev/*.rst
225+ docs/Developer/*.rst
226+ docs/Developer/*.png
227+ docs/Developer/*.md
228+ docs/Developer/*.rst
226 docs/Tutorials/*.md
229 docs/Tutorials/*.md
227 docs/Tutorials/*.hs
230 docs/Tutorials/*.hs
228 docs/HowTo/*.md
231 docs/HowTo/*.md