Add docs

Author: jclaggett

.gitignore

@@ -1,4 +1,5 @@
 ### Clerk ###
+.clerk/
 .cache/
 
 # Created by https://www.toptal.com/developers/gitignore/api/vim,clojure

README.md

@@ -1,8 +1,8 @@
 # Hassle
 
-An experimental reactive functional library for Clojure. The primary goal is to
-demonstrate the ability to express programs as a DAG of functions over streams
-of events.
+An experimental reactive functional library for Clojure. The primary goal
+is to demonstrate the ability to express programs as a DAG of functions
+over streams of events.
 
 ```clojure
 #_procedural-imperative
@@ -14,5 +14,10 @@ of events.
   (->> (input :init)
        (node (map #(str "Hello World")))
        (output :stdout)
-       net))
+       (net 'main)))
 ```
+
+## Usage
+
+Refer to `docs/xf-nets.clj` for an introduction to the various functions
+and supporting concepts.

docs/meetup.clj

@@ -0,0 +1,17 @@
+;; # Transducer Nets
+;; *Southern NH Clojure Group*
+
+;; *Wednesday, February 23, 2022*
+
+;; ## Outline
+;; 1. Intro *(you are here)*
+;; 2. Walk through the API offered to define transducer nets
+;; 3. Review the various transducers used under the hood
+;; 4. Next Steps & Discussion
+
+;; ## Intro
+;; * **What**: library that allows composition of transducers in Directed
+;; Acyclic Graph.
+;; * **Why**: Define Process Flow Networks with pure functions.
+;; * **Where**: https://github.com/jclaggett/hassle
+;; * **Status**: Experimental

docs/slides.md

@@ -1,4 +1,4 @@
-;; # Building the `net` transducer
+;; # Review of `net` transducers
 ;; It's transducers all the way down and so we can learn about the `net`
 ;; transducer by showing the more primitive transducers it uses.
 
@@ -11,9 +11,10 @@
   (require '[net.n01se.hassle.core
              :refer [net input node output]]))
 
-;; ## Transducer Family Tree
-;; This diagram shows the 'familty tree' of transducers used by `net`:
-;; [TODO] make a tree diagram!
+;; ## Transducer Composition Tree
+;; This diagram shows the 'composition tree' of transducers used to define `net` (blue are
+;; transducers added):
+(render-xf-compose-tree)
 
 ;; ## built-in transducers
 ;; Several of the most primitve transducers in the tree come standard with
@@ -81,8 +82,8 @@
 ;; `multiplex` is a higher order transducer that applies each value to multiple
 ;; transducers. The results of all transducers are returned in a sequence.
 ;; `multiplex` is reduced when all transducers are reduced. This particular
-;; transducer is directly inspired by the `multiplex` found over at
-;; https://github.com/cgrand/xforms
+;; transducer is directly inspired by the `multiplex` transducer found over at
+;; https://github.com/cgrand/xforms.
 (sequence (multiplex [(take 2) (map -)]) (range 1 5))
 (sequence (multiplex [(tag' :a) (tag' :b)]) (range 2))
 (sequence (multiplex [(detag' :a) (detag' :b)]) [[:b "j"] [:b "w"] [:a 1]])

docs/transducers.clj

@@ -40,6 +40,32 @@
       arr/as-svg
       clerk/html))
 
+(defn render-xf-compose-tree []
+ (-> (arr/create-graph)
+     (arr/with-graph
+       (let [v-map (arr/insert-vertex! "map")
+             v-take-while (arr/insert-vertex! "take-while")
+             v-filter (arr/insert-vertex! "filter")
+             v-final (arr/insert-vertex! "final" :fill-color "lightblue")
+             v-tag (arr/insert-vertex! "tag" :fill-color "lightblue")
+             v-detag (arr/insert-vertex! "detag" :fill-color "lightblue")
+             v-multiplex (arr/insert-vertex! "multiplex" :fill-color "lightblue")
+             v-demultiplex (arr/insert-vertex! "demultiplex" :fill-color "lightblue")
+             v-net (arr/insert-vertex! "net" :fill-color "lightblue")]
+         (arr/insert-edge! v-tag v-net)
+         (arr/insert-edge! v-detag v-net)
+         (arr/insert-edge! v-multiplex v-net)
+         (arr/insert-edge! v-demultiplex v-net)
+         (arr/insert-edge! v-final v-tag)
+         (arr/insert-edge! v-filter v-detag)
+         (arr/insert-edge! v-take-while v-detag)
+         (arr/insert-edge! v-map v-detag)))
+
+     arr/as-svg
+     clerk/html))
+
+
+
 (clerk/serve! {:browse? true})
 (clerk/serve! {:watch-paths ["docs" "src"]})
 (clerk/show! "docs/xf-nets.clj")