diff --git a/docs/guides/index.adoc b/docs/guides/index.adoc index a3d96f0d..a33c316f 100644 --- a/docs/guides/index.adoc +++ b/docs/guides/index.adoc @@ -30,14 +30,14 @@ image::https://github.com/Codamic/hellhound/raw/master/assets/hellhound-white.pn :sectnums: == What is HellHound? -asd +[PLACEHOLDER TEXT] === Goals -*HellHound* is a fullstack Clojure/ClojureScript framework for creating async distributed web applications suitbale for stream processing. -Basically *HellHound* is a set of smaller tools to create such systems. +*HellHound* is a fullstack Clojure/ClojureScript framework for creating asynchronous distributed web-applications suitable for stream-processing. +It is basically a set of smaller tools to help build such systems. -The goal is to create a tool which allows developers to focus on their business logic while it takes care of different aspect of a distributed +The goal of this project is to create a tool which allows developers to focus on their business logic while *HellHound* takes care of different aspects of their distributed software in an opinionated way. // Prerequisite diff --git a/docs/guides/prerequisite/index.adoc b/docs/guides/prerequisite/index.adoc index c2adeaf5..b02b4c04 100644 --- a/docs/guides/prerequisite/index.adoc +++ b/docs/guides/prerequisite/index.adoc @@ -1,14 +1,14 @@ = Prerequisite -Before learning about *HellHound* and how to use it. You need to know about several concepts and libraries -which are heavily used in *HellHound*. If you already know about the following topics, you can safely skip +Before learning more about *HellHound* and how to use it, you need to know about several concepts and libraries in advance +which are heavily used in *HellHound*. If you already know about these concepts in the following topics, you can easily skip this chapter and jump to [Getting Started](../getting_started/README.md) guide. == Commander Pattern -Have you ever hit a wall with REST? Does modeling your problem domain into CRUD-able entities feel like fitting -a square peg into a round hole? Perhaps instead of modeling our services like little databases, we should instead +Have you ever hit a wall with REST? Does modeling your problem-domain into CRUD-able entities feel like fitting +a square peg into a round hole? Perhaps, instead of modeling our services like little databases, we should instead model them like reactors over immutable event streams. -Commander pattern is an application architecture design which is the main idea behind *HellHound*. I highly recommend +Commander pattern is an application architecture design pattern which is used to build *HellHound*. In order to know more about the concept, it is highly recommend to watch this video: video::B1-gS0oEtYc[youtube,width=800,height=600] @@ -21,7 +21,7 @@ between libraries which use similar but incompatible abstractions. Manifold prov *deferreds*, which represent a single asynchronous value, and *streams*, which represent an ordered sequence of asynchronous values. -HellHound uses manifolds almost everywhere so it's a good idea learn about this fantastic library which brought to us +*HellHound* uses manifolds almost everywhere, so it's a good idea learn about this fantastic library which is brought to us by https://github.com/ztellman[@ztellman] and the awesome https://github.com/ztellman/manifold/graphs/contributors[contributors] of this library. @@ -30,9 +30,9 @@ for **streams**. [NOTE] ===== -If you're interested in Manifold you might want to know about the http://aleph.io/manifold/rationale.html[rationale] behind it. +If you're interested in Manifold, you might want to know about the http://aleph.io/manifold/rationale.html[rationale] behind it. ===== include::deferred.adoc[] -include::stream.adoc[] \ No newline at end of file +include::stream.adoc[]