docs(website): add initial documentation

Author: christianalfoni

package-lock.json

@@ -1,10 +1,83 @@
 # Action
 
-hihi
+```marksy
+<Example name="api_action" />
+```
 
+An action allows you to compose pieces of logic into an execution. You typically execute an action based on some user interaction in your application, but it could be everything from a route change to a websocket message as well.
 
-## Map
-Some operator code
+Actions are defined with a powerful chaining API which gives control of the execution itself. The asynchronocity of your execution is completely abstracted away, you only think about the logical order of execution and Overmind takes care of the rest.
 
-## Do
-Some more operator code
+The action is built up by **operators**, methods called on the action itself. These operators describes the execution logic.
+
+## debounce
+```marksy
+<Example name="api_action_debounce" />
+```
+
+Typically used to only continue execution of the last action call if multiple action calls has been made in the time limit passed in.
+
+The only argument is the time limit in milliseconds the operator should prevent action calls to continue. When the an action call has waited for the milliseconds defined, without any new action calls has been made, the execution will continue.
+
+## do
+```marksy
+<Example name="api_action_do" />
+```
+
+Typically used to fire off an effect without caring about its returned result, if any.
+
+Only argument is a function that receives the **effects** registered in the application as the first argument, and the current **value** of the action as the second argument. Any returned value will be ignored. The current value of the action will be passed to the next operator.
+
+## filter
+```marksy
+<Example name="api_action_filter" />
+```
+
+Typically used to stop execution related to some condition.
+
+The first argument is a function that receives the **effects** registered in the application as the first argument, and the current **value** as the second argument. If the function returns the value `false`, synchronously or asynchronously, the execution of the action will stop.
+
+## fork
+```marksy
+<Example name="api_action_fork" />
+```
+Typically used to fork out execution when a value can result in multiple complex executions.
+
+The first argument is a function that receives the **effects** as the first argument and the current **value** as the second. The function is expected to return a value, either synchronously or asynchronously, that matches the paths passed as the second argument to the fork operator.
+
+
+## map
+```marksy
+<Example name="api_action_map" />
+```
+
+Typically used to get values from an effect or transform the current value of the action.
+
+Only argument is a function that receives the **effects** registered in the application as the first argument, and the current **value** of the action as the second argument. The returned value will become the new value of the action.
+
+## mutation
+```marksy
+<Example name="api_action_mutation" />
+```
+
+Used to change the state of the application.
+
+Only argument is a function that receives the **state** as the first argument and the current **value** of the action as the second argument. This operator is the only operator that is allowed to mutate the state of the application.
+
+## try
+```marksy
+<Example name="api_action_try" />
+```
+
+Typically used to explicitly handle potentially thrown errors from an effect.
+
+The first argument is a function that receives the **effects** registered in the application as the first argument, and the current **value** as the second argument. The second argument to the operator are two paths, **success** and **error** which are respectively executed based on the success of the first argument function.
+
+## when
+```marksy
+<Example name="api_action_when" />
+```
+
+Typically used to fork execution based on a thruthy or falsy value.
+
+The first argument is a function that receives the **effects** registered in the application as the first argument, and the current **value** as the second argument. The second argument to the operator are two paths, **true** and **false** which are respectively executed based on the thruthyness of the returned value in the first argument function, which can be synchronous or asynchronous.

packages/overmind-website/api/action.md

@@ -1,16 +1,7 @@
 # App
 
 ```marksy
-<Code
-  js={
-`
-const foo = "bar"
-`
-  }
-  ts={
-`
-const foo: string = "bar"
-`
-  }
-/>
-```
+<Example name="api_app_initialize" view />
+```
+
+The **App** class is used to create the application instance. The instance itself exposes a **connect** function used to connect views to the state of the application and allow them to trigger actions.

packages/overmind-website/api/app.md

@@ -0,0 +1 @@
+# Compute

packages/overmind-website/api/compute.md

@@ -0,0 +1 @@
+# Connect

packages/overmind-website/api/connect.md

@@ -0,0 +1 @@
+# Derive

packages/overmind-website/api/derive.md

@@ -0,0 +1 @@
+# Effects

packages/overmind-website/api/effects.md

@@ -0,0 +1 @@
+# Namespaced

packages/overmind-website/api/namespaced.md

@@ -0,0 +1 @@
+# Reaction