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

Commit 13dc6c2

Browse files
committed
fixed some typos
1 parent ce4023c commit 13dc6c2

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

docs/packages/core/Introduction.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,22 @@ slug: /core
2222
## `core`
2323

2424
The `core` package is the brain of AgileTs.
25-
Nearly everything that has something to do with AgileTs depends on this package.
26-
The main reason for that, is that it holds the main `Agile Class`, here called `App`.
25+
Nearly everything that is related to AgileTs depends on this package.
26+
The main reason for this is that it includes the main Instance of AgileTs,
27+
the `Agile Class` here called `App`.
2728
```ts
2829
const App = new Agile();
2930
```
30-
In summary, the main tasks of such an instantiated `Agile Class` are to
31-
- manage our Agile Sub Instances ([State](./features/state/Introduction.md), ..)
31+
In summary, the main tasks of the `Agile Class` are to
32+
- manage and store our Agile Sub Instances ([State](./features/state/Introduction.md), ..)
3233
- ingest changes into the Runtime
3334
- trigger rerender on Integrations like [React](../react/Introduction.md)
3435

3536
As you can guess each application uses AgileTs has to install
36-
the `core` package and instantiate such an Agile Instance.
37-
To get some inspiration where to instantiate such `Agile Class`, checkout the [style guide](../../main/StyleGuide.md).
38-
Beside the Agile Instance the `core` holds some other useful classes which are
39-
listed below. But each of these classes depends in some kind on the Agile Instance.
37+
the `core` package and instantiate such an `Agile Class`.
38+
To get some inspiration where to instantiate our `Agile Class`, checkout the [style guide](../../main/StyleGuide.md).
39+
Beside the `Agile Class` the `core` holds some other useful classes which are
40+
listed below. But each of these classes depends in some kind on the `Agile Class`.
4041

4142
### ⚡️ [State](./features/state/Introduction.md)
4243
A State holds an Information that we need to remember at a later point in time.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ WIP docs!
1111

1212
:::
1313

14-
The _Agile Instance_ is the foundation of AgileTs,
15-
depends in some kind on it or even has its extension from it.
14+
The `Agile Class` is the foundation of AgileTs,
15+
nearly everything related to AgileTs depends in some kind on it.
1616
```ts
1717
const App = new Agile();
1818
```
19-
Each created Agile Instance should be unique to our application, and
20-
it isn't recommended having multiple Agile Instances a single application.
19+
Each created Agile Instance should be unique to our application,
20+
and we should avoid having multiple from these in one application.
2121
The Agile Instance can be seen as the store, which offers many powerful features
2222
to mutate and work with the stored Instances.
23-
Such Instances can be created with help of the Agile Instance.
23+
Such Instances can be created with help of the Agile Instance and get automatically stored in it.
2424
- [State](../state/Introduction.md)
2525
```ts
2626
const MY_STATE = App.createState("Hello there");

0 commit comments

Comments
 (0)