Merge pull request #77 from agile-ts/develop

Develop

Author: bennobuilder

docs/packages/core/Introduction.md

@@ -5,7 +5,7 @@ sidebar_label: Introduction
 slug: /core
 ---
 
-> **Brain of AgileTs**
+> Global State and Logic Framework
 
 <br />
 
@@ -22,8 +22,7 @@ slug: /core
 ## ❓ `core`
 
 The `core` is the main package of AgileTs and includes the whole state management logic.
-Therefore, it can be seen as the brain of AgileTs that manages all our States.
-It includes the main Instance of AgileTs, called [`Agile Class`](./features/agile-instance/Introduction.md).
+It contains the main Instance of AgileTs, called [`Agile Class`](./features/agile-instance/Introduction.md).
 ```ts
 const App = new Agile();
 ```
@@ -36,7 +35,7 @@ In summary, the most important tasks of the `Agile Class` are to:
 Each application using AgileTs needs the `core` package 
 and has to instantiate a `Agile Class` often called `App`.
 To get some inspiration where to instantiate the `Agile Class`, check out the [Style Guide](../../main/StyleGuide.md) Section.
-Besides the `Agile Class` the `core` holds some other useful classes,
+Besides, the `Agile Class` the `core` holds some other useful classes,
 which represent the actual features of AgileTs, since the `Agile Class`
 is mostly used internally.
 

docs/packages/core/features/agile-instance/Introduction.md

@@ -11,14 +11,14 @@ WIP docs!
 
 :::
 
-The `Agile Class` is the foundation of AgileTs. Everything related to AgileTs depends on this class in different ways.
+
+The `Agile Class` is the main Instance of AgileTs and should be unique to our application.
 ```ts
 const App = new Agile();
 ```
-It can be seen as your application store, which manages each `Agile Sub Instance` (ASI).
-The `Agile Class` doesn't contain these ASI's internally, but each ASI includes a reference to the main `Agile Class`. 
-For instance, to pass something into the `runtime`.
-Here are some Agile Sub Instances (ASI):
+It can be seen as our application manager. Each `Agile Sub Instance` (ASI) holds a reference 
+to the `Agile Class` and depends on its functionalities. <br/>
+For reference here are some `Agile Sub Instances` (ASI):
 
 - [State](../state/Introduction.md)
   ```ts
@@ -36,17 +36,14 @@ Here are some Agile Sub Instances (ASI):
    ```ts
    const MY_EVENT = App.createEvent();
    ```
-
-These ASI's are created with the help of an `Agile Instance` and get automatically bound to it.
-In summary, the main tasks of an instantiated `Agile Class` (Agile Instance) are to:
+  
+In summary the main tasks of the `AgileClass` are to:
 - manage Agile Sub Instances, like [States](../state/Introduction.md), ..
-- ingest changes into the Runtime
+- ingest changes into the Runtime (queue system for managing ASI mutations)
+- provide configuration object
 - trigger rerender on Integrations like [React](../../../react/Introduction.md)
 - store values in any [Storage](../storage/Introduction.md)
 
-Be aware that each application using AgileTs needs at least one `Agile Instance`,
-but also shouldn't have more, because multiple `Agile Instance` in one application might cause trouble.
-
 ## 📭 Props
 
 ### `config`

docs/packages/core/features/agile-instance/Methods.md

@@ -7,7 +7,7 @@ slug: /core/agile-instance/methods
 
 :::info
 
-Here all methods of the `Agile Instance` are described.
+Here are valuable methods of the `Agile Instance` listed.
 
 :::
 
@@ -53,16 +53,16 @@ which is automatically bound to the [Agile Instance](../agile-instance/Introduct
 ```ts {1-4,8-13}
 const Collection = App.createCollection({
     key: 'dummyCollection',
-   groups: ['myGroup']
+    groups: ['myGroup']
 })
 
 // or 
 
 const Collection2 = App.createCollection((collection) => ({
-   key: 'dummyCollection',
-   groups: {
-       myGroup: collection.Group(['item1', 'item2'])
-   }
+    key: 'dummyCollection',
+    groups: {
+        myGroup: collection.Group(['item1', 'item2'])
+    }
 }))
 ```
 
@@ -100,7 +100,7 @@ const Computed = App.createComputed(() => {/* Computed Method */}, [/* hard code
 // or
 
 const ComputedWithConfig = App.createComputed(() => {/* Computed Method */}, {
-   key: 'dummyComputed',
+    key: 'dummyComputed',
 }, [/* hard coded deps */])
 ```
 
@@ -166,10 +166,10 @@ Returns a fresh [Event](../event/Introduction.md).
 ## `integrate()`
 
 With `integrate()` we can integrate any Framework [Integration](../integration/Introduction.md) into AgileTs.
-An Integration simply tells AgileTs, howto mutate a particular Component,
+An Integration simply tells AgileTs, howto mutates a particular Component
 whenever a State changes. To bind States to Components and thus be reactive,
 any Framework using AgileTs needs an Integration for AgileTs.
-For example, to use AgileTs in a [React](https://reactjs.org/) environment, 
+For example, to use AgileTs in a [React](https://reactjs.org/) environment,
 we have to register a React Integration to AgileTs.
 ```ts
 App.integrate(reactIntegration);
@@ -200,7 +200,7 @@ const reactIntegration = new Integration<typeof React, AgileReactComponent>({
   },
 });
 
-// Each initialIntegraion gets integrated into AgileTs automatically during initialation
+// Each initialIntegraion gets integrated into AgileTs automatically during initialisation
 Agile.initialIntegrations.push(reactIntegration);
 ```
 

docs/packages/core/features/agile-instance/Properties.md

@@ -7,7 +7,7 @@ slug: /core/agile-instance/properties
 
 :::info
 
-Here useful properties of the `Agile Instance` are described.
+Here are valuable properties of the `Agile Instance` listed.
 
 :::
 

docs/packages/core/features/collection/Introduction.md

@@ -33,7 +33,7 @@ Most methods we use to modify, mutate and access the Collection are chainable.
 MY_COLLECTION.collect({id: 1, name: "jeff"}).persist().removeGroup('myGroup').reset();
 ```
 
-### 🔨 Usage
+### 🔨 Use case
 
 For instance a Collection can be used to remember a flexible array of Todo objects.
 ```ts