Skip to content

Commit

Permalink
Restructure reference guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
zainab-ali committed Aug 29, 2024
1 parent e2cec99 commit 0c19c93
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Aquascape is a diagramming tool for [fs2](https://github.com/typelevel/fs2).

The diagrams can be used to illustrate the behaviour of fs2 operators. By reading the diagrams, you will learn more about the operators and streams.

This website contains an aquascape-based reference guide to fs2, based on aquascapes. Read it [here](reference/README.md).

## The basic idea

A stream is built from **stages**. When evaluated:
Expand Down
17 changes: 17 additions & 0 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Reference Guide

This is an aquascape-based reference guide to fs2.

Learn [how to read aquascapes](../README.md#how-to-read-the-diagrams), then learn about an operator:

- [take, takeWhile, takeThrough, takeRight](take.md)
- [drop, dropWhile, dropThrough, dropLast, dropLastIf](drop.md)
- [filter, filterNot, filterWithPrevious, changes, mapFilter](filter.md)
- [evalMap, evalTap, evalMapChunk, evalTapChunk](evalMap.md)
- [bracket, bracketCase, resource, onFinalize, onFinalizeCase](bracket.md)
- [merge, mergeHaltL, mergeHaltR](merge.md)
- [flatMap](flatMap.md)
- [append, `++`](append.md)
- [raiseError, handleError, handleErrorWith, attempt](errors.md)
- [chunks, unchunks, chunkLimit, chunkMin, chunkN](chunk.md)

0 comments on commit 0c19c93

Please sign in to comment.