Merge pull request #32 from agile-ts/develop

Develop

Author: bennobuilder

.gitignore

@@ -1,6 +1,8 @@
 # Dependencies
 /node_modules
 dist
+yalc.lock
+/.yalc
 
 # Production
 /build

docs/Interfaces.md

@@ -467,6 +467,7 @@ MY_STATE.persist({storageKeys: ['myCustomStorrage']}); // Stores value in 'myCus
 
 ## `GroupConfig`
 
+This is the `GroupConfig` Interface, and it is used as config object in the creation of Groups.
 Here is a Typescript Interface of the Object for quick reference, 
 however each property will be explained in more detail below.
 ```ts
@@ -480,7 +481,7 @@ export interface GroupConfigInterface {
 
 #### `key`
 
-Key/Name of Group 
+Key/Name of Group.
 
 | Type                     | Default   | Required |
 |--------------------------|-----------|----------|
@@ -490,7 +491,7 @@ Key/Name of Group
 
 #### `isPlaceholder`
 
-If Group is initially a Placeholder  
+If Group is initially a Placeholder.  
 
 | Type                     | Default   | Required |
 |--------------------------|-----------|----------|
@@ -508,6 +509,7 @@ If Group is initially a Placeholder
 
 ## `SelectorConfig`
 
+This is the `SelectorConfig` Interface, and it is used as config object in the creation of Selectors.
 Here is a Typescript Interface of the Object for quick reference, 
 however each property will be explained in more detail below.
 ```ts
@@ -521,7 +523,7 @@ export interface SelectorConfigInterface {
 
 #### `key`
 
-Key/Name of Selector 
+Key/Name of Selector. 
 
 | Type                     | Default   | Required |
 |--------------------------|-----------|----------|
@@ -531,7 +533,7 @@ Key/Name of Selector
 
 #### `isPlaceholder`
 
-If Selector is initially a Placeholder  
+If Selector is initially a Placeholder.
 
 | Type                     | Default   | Required |
 |--------------------------|-----------|----------|
@@ -549,6 +551,9 @@ If Selector is initially a Placeholder
 
 ## `CollectConfig`
 
+This is the `CollectConfig` Interface, and it is used as config object in the `collect` method.
+Here is a Typescript Interface of the Object for quick reference,
+however each property will be explained in more detail below.
 ```ts
 export interface CollectConfigInterface<DataType = any> {
   patch?: boolean;
@@ -559,6 +564,19 @@ export interface CollectConfigInterface<DataType = any> {
 }
 ```
 
+<br/>
+
+#### `key`
+
+Key/Name of Selector.
+
+| Type                     | Default   | Required |
+|--------------------------|-----------|----------|
+| `string \| name`         | undefined | No       |
+
+<br/>
+
+
 | Prop              | Type                     | Default     | Description                                                                                                             | Required |
 |-------------------|--------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------|----------|
 | patch               | boolean         | false   | Key/Name of Selector                                                                                                    | No       |

docs/main/Introduction.md

@@ -2,7 +2,7 @@
 id: introduction
 title: AgileTs
 sidebar_label: Introduction
-slug: /
+slug: /introduction/
 ---
 
 > **Spacy, Simple, Scalable State Management Framework**

docs/main/StyleGuide.md

@@ -142,7 +142,7 @@ export const addTodo = async (userId: string, description: string): Promise<void
 The Controller of an Entity holds and controls States, Collections, .. for that Entity.
 These Agile Sub Instances might get modified by [actions](#📝-.action.ts) or bound to a Component in the UI-Layer.
 
-```ts title="todo.controller.ts in 📁todo"
+```ts title="todo.ui.controller.ts in 📁todo"
 import {App} from '../../app';
 import {TodoInterface} from './todo.interface';
 import {CURRENT_USER} from '../user'

docusaurus.config.js

@@ -8,7 +8,7 @@ const customFields = {
   githubOrgUrl,
   githubUrl: `${githubOrgUrl}/agile`,
   githubDocsUrl: `${githubOrgUrl}/documentation`,
-  discordUrl: `https://discord.gg/FTqeMNCxw7`,
+  discordUrl: `https://discord.gg/T9GzreAwPH`,
   stackoverflowUrl: "https://stackoverflow.com/questions/tagged/agile-ts",
   twitterUrl: "https://twitter.com/AgileFramework",
   version: "0.0.1",
@@ -68,10 +68,6 @@ const config = {
           label: "Get Started",
           position: "left",
           items: [
-            {
-              label: "Introduction",
-              to: "/docs/",
-            },
             {
               label: "Installation",
               to: "/docs/installation/",
@@ -80,6 +76,10 @@ const config = {
               label: "React",
               to: "/docs/quick-start/react/",
             },
+            {
+              label: "Style Guide",
+              to: "/docs/style-guide/",
+            },
           ],
         },
         {
@@ -88,43 +88,27 @@ const config = {
           items: [
             {
               label: "GitHub",
-              to: customFields.githubUrl,
+              href: customFields.githubUrl,
             },
             {
               label: "Discord",
-              to: customFields.discordUrl,
+              href: customFields.discordUrl,
             },
             {
               label: "Stack Overflow",
-              to: customFields.stackoverflowUrl,
+              href: customFields.stackoverflowUrl,
             },
             {
               label: "Twitter",
-              to: customFields.twitterUrl,
+              href: customFields.twitterUrl,
             },
           ],
         },
         {
           label: "Documentation",
           position: "left",
-          to: "docs/",
+          to: "docs/introduction/",
         },
-        // {to: 'blog', label: 'Blog', position: 'left'},
-        /*
-                // right
-                {
-                    href: 'https://github.com/agile-ts/agile',
-                    position: 'right',
-                    className: 'header-github-link header-icon-link',
-                    'aria-label': 'GitHub repository',
-                },
-                {
-                    href: 'https://discord.gg/FTqeMNCxw7',
-                    position: 'right',
-                    className: 'header-discord-link header-icon-link',
-                    'aria-label': 'Discord',
-                },
-                 */
       ],
     },
     footer: {
@@ -135,7 +119,7 @@ const config = {
           items: [
             {
               label: "Get Started",
-              to: "docs/",
+              to: "docs/introduction",
             },
           ],
         },
@@ -144,7 +128,7 @@ const config = {
           items: [
             {
               label: "Stack Overflow",
-              to: customFields.stackoverflowUrl,
+              href: customFields.stackoverflowUrl,
             },
             {
               label: "Discord",
@@ -165,7 +149,7 @@ const config = {
             },
             {
               label: "GitHub",
-              to: customFields.githubUrl,
+              href: customFields.githubUrl,
             },
           ],
         },

package.json

@@ -1,19 +1,21 @@
 {
   "name": "agile-docs",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
-    "serve": "docusaurus serve"
+    "serve": "docusaurus serve",
+    "buildserve": "yarn run build && yarn run serve",
+    "install-docusaurus": "yalc add @docusaurus/core & yarn install"
   },
   "dependencies": {
     "@agile-ts/core": "0.0.10",
     "@agile-ts/react": "0.0.10",
-    "@docusaurus/core": "2.0.0-alpha.70",
+    "@docusaurus/core": "^2.0.0-alpha.70",
     "@docusaurus/module-type-aliases": "^2.0.0-alpha.70",
     "@docusaurus/preset-classic": "^2.0.0-alpha.70",
     "@docusaurus/remark-plugin-npm2yarn": "^2.0.0-alpha.70",
@@ -28,15 +30,16 @@
     "react-live": "^2.2.3",
     "react-spring": "^8.0.27",
     "react-toastify": "^6.2.0",
-    "styled-components": "^5.1.1"
+    "styled-components": "^5.2.1"
   },
   "devDependencies": {
     "@types/node": "^12.0.0",
     "@types/react": "^17.0.0",
     "@types/react-dom": "^16.9.8",
     "@types/react-helmet": "^6.1.0",
     "@types/react-router-dom": "^5.1.6",
-    "@types/styled-components": "^5.1.0"
+    "@types/styled-components": "^5.1.0",
+    "typescript": "^4.1.5"
   },
   "browserslist": {
     "production": [