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

Commit cea26e9

Browse files
committed
bumped docusaurus version
1 parent 7909001 commit cea26e9

File tree

4 files changed

+929
-1915
lines changed

4 files changed

+929
-1915
lines changed

docs/main/Introduction.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,6 @@ Therefore, AgileTs should be used as a friend and helper to outsource all busine
120120

121121
AgileTs is 99% written in Typescript and offers an excellent type-safety.
122122

123-
## 👨‍🏫 Learn AgileTs
124-
125-
We have a variety of resources available to help you learn AgileTs. An excellent place to start are
126-
our [Quick Start](./Installation.md) Guides, where you learn the basics about how to use AgileTs in a specific
127-
Framework. After knowing the ground concept of AgileTs, we recommend checking out the [Style Guides](./StyleGuide.md).
128-
The Style Guides will help you to get some inspiration on structuring a scalable application using AgileTs. Now you
129-
are ready to use AgileTs wherever you want. If you need some more information about some functionalities of AgileTs,
130-
use the search bar in the top right corner. And in case you have any further questions, don't hesitate to join our [Community Discord](https://discord.gg/T9GzreAwPH).
131-
132123
## 👮 Data Flow
133124

134125
![Log Custom Styles Example](../../static/img/docs/data-flow.png)
@@ -178,7 +169,7 @@ THEME_STATE.ingestValue(/* new value of THEME_STATE */);
178169
#### `4`
179170

180171
The Observer then creates a Job and passes it to the Runtime.
181-
The created Job has a reference to the Observer itself in order to perform the actual action
172+
The created Job has a reference to the Observer itself in order to perform the actual action
182173
and rerender the correct UI-Components.
183174
```ts
184175
// ..
@@ -203,13 +194,22 @@ jobsToRerender.push(job);
203194
#### `6`
204195

205196
A side effect of running a Job is the rerendering of subscribed Components.
206-
Another could be the persisting into a permanent Storage or rebuilding the Group output.
197+
Another could be the persisting into a permanent Storage or rebuilding the [Group](../packages/core/features/collection/group/Introduction.md) output.
207198
```ts
208199
// ..
209200
subscriptionContainer.callback(); // If Component based Subscription
210201
// ..
211202
```
212203

204+
## 👨‍🏫 Learn AgileTs
205+
206+
We have a variety of resources available to help you learn AgileTs. An excellent place to start are
207+
our [Quick Start](./Installation.md) Guides, where you learn the basics about how to use AgileTs in a specific
208+
Framework. After knowing the ground concept of AgileTs, we recommend checking out the [Style Guides](./StyleGuide.md).
209+
The Style Guides will help you to get some inspiration on structuring a scalable application using AgileTs. Now you
210+
are ready to use AgileTs wherever you want. If you need some more information about some functionalities of AgileTs,
211+
use the search bar in the top right corner. And in case you have any further questions, don't hesitate to join our [Community Discord](https://discord.gg/T9GzreAwPH).
212+
213213
## 🏢 Structure of Documentation
214214

215215
### 📁 AgileTs
@@ -258,6 +258,16 @@ and depend on its functionalities.
258258
- [Selectors](../packages/core/features/collection/selector/Introduction.md)
259259
- [Computed States](../packages/core/features/computed/Introduction.md)
260260

261+
### `Observer`
262+
263+
Interface to the [runtime](#runtime) which keeps track of subscribed UI-Components
264+
and performs the actual State action executed by the runtime.
265+
266+
### `Runtime`
267+
268+
Queues and executes passed Jobs holding an [Observer](#observer)
269+
and performs rerender on subscribed UI-Components.
270+
261271
## 💬 What others say
262272

263273
Actually, nothing, yet. If you want to be the first one, don't mind tweeting whatever you think about AgileTs.

docs/packages/react/features/Hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ an `Observer` to React Components.
265265
const [myCollection, myGroup, myState] = useProxy([MY_COLLECTION, MY_GROUP, MY_STATE]);
266266
```
267267
However, the [Proxy()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) is only wrapped
268-
around objects and arrays. The other instances are treated as in [useAgile()](#useagile).
268+
around objects and arrays. The other instances are treated as in [`useAgile()`](#useagile).
269269

270270
### 🔴 Example
271271

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
"@agile-ts/core": "^0.0.15",
2222
"@agile-ts/event": "^0.0.5",
2323
"@agile-ts/react": "^0.0.16",
24-
"@docusaurus/core": "^2.0.0-alpha.74",
25-
"@docusaurus/module-type-aliases": "^2.0.0-alpha.74",
26-
"@docusaurus/preset-classic": "^2.0.0-alpha.74",
27-
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-alpha.74",
28-
"@docusaurus/theme-live-codeblock": "^2.0.0-alpha.74",
24+
"@docusaurus/core": "^2.0.0-beta.0",
25+
"@docusaurus/module-type-aliases": "^2.0.0-beta.0",
26+
"@docusaurus/preset-classic": "^2.0.0-beta.0",
27+
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.0",
28+
"@docusaurus/theme-live-codeblock": "^2.0.0-beta.0",
2929
"@mdx-js/react": "^1.6.21",
3030
"@tsconfig/docusaurus": "^1.0.2",
3131
"clsx": "^1.1.1",

0 commit comments

Comments
 (0)