Skip to content

fixed typos and reformatted text. #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lxsameer merged 2 commits into from
Oct 21, 2017
Merged

fixed typos and reformatted text. #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eea972
fixed typos and reformatted text.
mostafa Oct 21, 2017
05408f5
fixed typos and made the text a little better.
mostafa Oct 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guides/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/guides/prerequisite/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand All @@ -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.

Expand All @@ -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[]
include::stream.adoc[]