Skip to content
This repository was archived by the owner on Feb 15, 2025. It is now read-only.

Commit b0e9def

Browse files
authored
Merge pull request #32 from agile-ts/develop
Develop
2 parents 7e2e9df + d5cf1f7 commit b0e9def

33 files changed

+773
-291
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Dependencies
22
/node_modules
33
dist
4+
yalc.lock
5+
/.yalc
46

57
# Production
68
/build

docs/Interfaces.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,7 @@ MY_STATE.persist({storageKeys: ['myCustomStorrage']}); // Stores value in 'myCus
467467

468468
## `GroupConfig`
469469

470+
This is the `GroupConfig` Interface, and it is used as config object in the creation of Groups.
470471
Here is a Typescript Interface of the Object for quick reference,
471472
however each property will be explained in more detail below.
472473
```ts
@@ -480,7 +481,7 @@ export interface GroupConfigInterface {
480481

481482
#### `key`
482483

483-
Key/Name of Group
484+
Key/Name of Group.
484485

485486
| Type | Default | Required |
486487
|--------------------------|-----------|----------|
@@ -490,7 +491,7 @@ Key/Name of Group
490491

491492
#### `isPlaceholder`
492493

493-
If Group is initially a Placeholder
494+
If Group is initially a Placeholder.
494495

495496
| Type | Default | Required |
496497
|--------------------------|-----------|----------|
@@ -508,6 +509,7 @@ If Group is initially a Placeholder
508509

509510
## `SelectorConfig`
510511

512+
This is the `SelectorConfig` Interface, and it is used as config object in the creation of Selectors.
511513
Here is a Typescript Interface of the Object for quick reference,
512514
however each property will be explained in more detail below.
513515
```ts
@@ -521,7 +523,7 @@ export interface SelectorConfigInterface {
521523

522524
#### `key`
523525

524-
Key/Name of Selector
526+
Key/Name of Selector.
525527

526528
| Type | Default | Required |
527529
|--------------------------|-----------|----------|
@@ -531,7 +533,7 @@ Key/Name of Selector
531533

532534
#### `isPlaceholder`
533535

534-
If Selector is initially a Placeholder
536+
If Selector is initially a Placeholder.
535537

536538
| Type | Default | Required |
537539
|--------------------------|-----------|----------|
@@ -549,6 +551,9 @@ If Selector is initially a Placeholder
549551

550552
## `CollectConfig`
551553

554+
This is the `CollectConfig` Interface, and it is used as config object in the `collect` method.
555+
Here is a Typescript Interface of the Object for quick reference,
556+
however each property will be explained in more detail below.
552557
```ts
553558
export interface CollectConfigInterface<DataType = any> {
554559
patch?: boolean;
@@ -559,6 +564,19 @@ export interface CollectConfigInterface<DataType = any> {
559564
}
560565
```
561566

567+
<br/>
568+
569+
#### `key`
570+
571+
Key/Name of Selector.
572+
573+
| Type | Default | Required |
574+
|--------------------------|-----------|----------|
575+
| `string \| name` | undefined | No |
576+
577+
<br/>
578+
579+
562580
| Prop | Type | Default | Description | Required |
563581
|-------------------|--------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------|----------|
564582
| patch | boolean | false | Key/Name of Selector | No |

docs/main/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: introduction
33
title: AgileTs
44
sidebar_label: Introduction
5-
slug: /
5+
slug: /introduction/
66
---
77

88
> **Spacy, Simple, Scalable State Management Framework**

docs/main/StyleGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ export const addTodo = async (userId: string, description: string): Promise<void
142142
The Controller of an Entity holds and controls States, Collections, .. for that Entity.
143143
These Agile Sub Instances might get modified by [actions](#📝-.action.ts) or bound to a Component in the UI-Layer.
144144

145-
```ts title="todo.controller.ts in 📁todo"
145+
```ts title="todo.ui.controller.ts in 📁todo"
146146
import {App} from '../../app';
147147
import {TodoInterface} from './todo.interface';
148148
import {CURRENT_USER} from '../user'

docusaurus.config.js

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const customFields = {
88
githubOrgUrl,
99
githubUrl: `${githubOrgUrl}/agile`,
1010
githubDocsUrl: `${githubOrgUrl}/documentation`,
11-
discordUrl: `https://discord.gg/FTqeMNCxw7`,
11+
discordUrl: `https://discord.gg/T9GzreAwPH`,
1212
stackoverflowUrl: "https://stackoverflow.com/questions/tagged/agile-ts",
1313
twitterUrl: "https://twitter.com/AgileFramework",
1414
version: "0.0.1",
@@ -68,10 +68,6 @@ const config = {
6868
label: "Get Started",
6969
position: "left",
7070
items: [
71-
{
72-
label: "Introduction",
73-
to: "/docs/",
74-
},
7571
{
7672
label: "Installation",
7773
to: "/docs/installation/",
@@ -80,6 +76,10 @@ const config = {
8076
label: "React",
8177
to: "/docs/quick-start/react/",
8278
},
79+
{
80+
label: "Style Guide",
81+
to: "/docs/style-guide/",
82+
},
8383
],
8484
},
8585
{
@@ -88,43 +88,27 @@ const config = {
8888
items: [
8989
{
9090
label: "GitHub",
91-
to: customFields.githubUrl,
91+
href: customFields.githubUrl,
9292
},
9393
{
9494
label: "Discord",
95-
to: customFields.discordUrl,
95+
href: customFields.discordUrl,
9696
},
9797
{
9898
label: "Stack Overflow",
99-
to: customFields.stackoverflowUrl,
99+
href: customFields.stackoverflowUrl,
100100
},
101101
{
102102
label: "Twitter",
103-
to: customFields.twitterUrl,
103+
href: customFields.twitterUrl,
104104
},
105105
],
106106
},
107107
{
108108
label: "Documentation",
109109
position: "left",
110-
to: "docs/",
110+
to: "docs/introduction/",
111111
},
112-
// {to: 'blog', label: 'Blog', position: 'left'},
113-
/*
114-
// right
115-
{
116-
href: 'https://github.com/agile-ts/agile',
117-
position: 'right',
118-
className: 'header-github-link header-icon-link',
119-
'aria-label': 'GitHub repository',
120-
},
121-
{
122-
href: 'https://discord.gg/FTqeMNCxw7',
123-
position: 'right',
124-
className: 'header-discord-link header-icon-link',
125-
'aria-label': 'Discord',
126-
},
127-
*/
128112
],
129113
},
130114
footer: {
@@ -135,7 +119,7 @@ const config = {
135119
items: [
136120
{
137121
label: "Get Started",
138-
to: "docs/",
122+
to: "docs/introduction",
139123
},
140124
],
141125
},
@@ -144,7 +128,7 @@ const config = {
144128
items: [
145129
{
146130
label: "Stack Overflow",
147-
to: customFields.stackoverflowUrl,
131+
href: customFields.stackoverflowUrl,
148132
},
149133
{
150134
label: "Discord",
@@ -165,7 +149,7 @@ const config = {
165149
},
166150
{
167151
label: "GitHub",
168-
to: customFields.githubUrl,
152+
href: customFields.githubUrl,
169153
},
170154
],
171155
},

package.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
{
22
"name": "agile-docs",
3-
"version": "0.0.0",
3+
"version": "0.0.1",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
77
"start": "docusaurus start",
88
"build": "docusaurus build",
99
"swizzle": "docusaurus swizzle",
1010
"deploy": "docusaurus deploy",
11-
"serve": "docusaurus serve"
11+
"serve": "docusaurus serve",
12+
"buildserve": "yarn run build && yarn run serve",
13+
"install-docusaurus": "yalc add @docusaurus/core & yarn install"
1214
},
1315
"dependencies": {
1416
"@agile-ts/core": "0.0.10",
1517
"@agile-ts/react": "0.0.10",
16-
"@docusaurus/core": "2.0.0-alpha.70",
18+
"@docusaurus/core": "^2.0.0-alpha.70",
1719
"@docusaurus/module-type-aliases": "^2.0.0-alpha.70",
1820
"@docusaurus/preset-classic": "^2.0.0-alpha.70",
1921
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-alpha.70",
@@ -28,15 +30,16 @@
2830
"react-live": "^2.2.3",
2931
"react-spring": "^8.0.27",
3032
"react-toastify": "^6.2.0",
31-
"styled-components": "^5.1.1"
33+
"styled-components": "^5.2.1"
3234
},
3335
"devDependencies": {
3436
"@types/node": "^12.0.0",
3537
"@types/react": "^17.0.0",
3638
"@types/react-dom": "^16.9.8",
3739
"@types/react-helmet": "^6.1.0",
3840
"@types/react-router-dom": "^5.1.6",
39-
"@types/styled-components": "^5.1.0"
41+
"@types/styled-components": "^5.1.0",
42+
"typescript": "^4.1.5"
4043
},
4144
"browserslist": {
4245
"production": [

0 commit comments

Comments
 (0)