git.iko.soy/streamly
on master help sign in
Move dev/* (developer docs) into docs/Developer/*
commit6f3371e656dd6d6533917889e9e9470fdc0679d4 authorAdithya Kumar <adithya@composewell.com> dateWed 30 Mar 2022, 03:31 (5 years ago) parent1aa7e60
21 files changed+14−8
compare with master
unifiedsplit
CONTRIBUTING.md+1−1 benchmark/README.md+1−1 dev/MAINTAINING.md → docs/Developer/MAINTAINING.md dev/ci-tests.md → docs/Developer/ci-tests.md dev/container-api.md → docs/Developer/container-api.md dev/cps-vs-direct.rst → docs/Developer/cps-vs-direct.rst dev/dfa-bytes.png → docs/Developer/dfa-bytes.png dev/dfa-classes.png → docs/Developer/dfa-classes.png dev/dfa-rearr.png → docs/Developer/dfa-rearr.png dev/linked-lists.md → docs/Developer/linked-lists.md dev/module-organization.md → docs/Developer/module-organization.md dev/optimization-guidelines.md → docs/Developer/optimization-guidelines.md dev/overview.md → docs/Developer/overview.md dev/paths.rst → docs/Developer/paths.rst dev/related-packages.md → docs/Developer/related-packages.md dev/resources.md → docs/Developer/resources.md dev/roadmap.md → docs/Developer/roadmap.md dev/unicode.md → docs/Developer/unicode.md dev/utf8-decoder.md → docs/Developer/utf8-decoder.md+3−3 docs/streamly-docs.cabal+3 streamly.cabal+6−3
CONTRIBUTING.md+1−1
@@ -222,7 +222,7 @@ copying does not have an associated license please do not use it.
222222
223223* Use https://streamly.composewell.com/ for searching in reference docs
224224* 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.
226226
227227## Coding Guidelines
228228
benchmark/README.md+1−1
@@ -310,7 +310,7 @@ they are usually annotated so in their documentation.
310310### Resolving the problem
311311
312312Review 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
314314solve those. If no obvious issues are found on review, then generate and
315315examine the core.
316316
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
263263the graph are disallowed; they all lead to state one, which has been
264264omitted for readability.
265265
266−![DFA with range transitions](/dev/dfa-bytes.png)
266+![DFA with range transitions](/docs/Developer/dfa-bytes.png)
267267
268268### Automaton with character class transitions
269269
@@ -273,7 +273,7 @@ encoding the ranges directly, the ranges are split such that each byte
273273belongs to exactly one character class. Then the transitions go over
274274these character classes.
275275
276−![DFA with class transitions](/dev/dfa-classes.png)
276+![DFA with class transitions](/docs/Developer/dfa-classes.png)
277277
278278### Mapping bytes to character classes
279279
@@ -404,7 +404,7 @@ the non-ASCII starter is swapped (approximately a 5% increase), but GCC
404404I have experimented with various rearrangements of states and character
405405classes. A seemingly promising one is the following:
406406
407−![Re-arranged DFA with class transitions](/dev/dfa-rearr.png)
407+![Re-arranged DFA with class transitions](/docs/Developer/dfa-rearr.png)
408408
409409One of the continuation ranges has been split into two, the other
410410changes are just renamings. This arrangement allows, when a continuation
docs/streamly-docs.cabal+3
@@ -22,6 +22,9 @@ extra-doc-files:
2222 Explanation/streaming-pradigms.rst
2323 ProjectRelated/*.md
2424 ProjectRelated/Roadmap.link
25+ Developer/*.png
26+ Developer/*.md
27+ Developer/*.rst
2528
2629library
2730 default-language: Haskell2010
streamly.cabal+6−3
@@ -220,9 +220,12 @@ extra-doc-files:
220220 CHANGELOG.md
221221 README.md
222222 benchmark/README.md
223− dev/*.md
224− dev/*.png
225− dev/*.rst
223+ docs/Developer/*.png
224+ docs/Developer/*.md
225+ docs/Developer/*.rst
226+ docs/Developer/*.png
227+ docs/Developer/*.md
228+ docs/Developer/*.rst
226229 docs/Tutorials/*.md
227230 docs/Tutorials/*.hs
228231 docs/HowTo/*.md