Skip to content

Commit

Permalink
-
Browse files Browse the repository at this point in the history
  • Loading branch information
Falcion committed Feb 13, 2024
1 parent 59d2bb4 commit 870a605
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/code/_machine/_assembler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Plan of writing documentation:

1. Introduction to the assembler.
2. Introduction to the addons of the assembler:
1. Broker addon;
2. Sender addon;
3. Purpose of the assembler's instance.
4. *[Philosophy of an assembler]
1. *How does the logic of internal parameters presents;
2. *How does the logic of changing stateflows presents;
3. *What the idea behind the assembler main module's representation;
4. Which modules do what;
5. Common sense of assembler - writing;
5. Tech-docs via XML;
8 changes: 8 additions & 0 deletions docs/code/_machine/addons/_broker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
1. What is the "broker" of assembler of state machine? (introduction)
2. What does it do?
- common sence of working logic of entire instance
3. Internal synergy: how does fields work in coalition?
- logic behind the usage of specified fields, and how they cowork with others
4. Internal synergy: how does methods work in coalition?
- logic behind the usage of specified methods, and how they cowork with others
5. External synergy: what the logic behind the entire of broker? How does it work and what is it's differences?
8 changes: 8 additions & 0 deletions docs/code/_machine/addons/_sender.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
1. What is the "sender" of assembler of state machine? (introduction)
2. What does it do?
- common sence of working logic of entire instance
3. Internal synergy: how does fields work in coalition?
- logic behind the usage of specified fields, and how they cowork with others
4. Internal synergy: how does methods work in coalition?
- logic behind the usage of specified methods, and how they cowork with others
5. External synergy: what the logic behind the entire of sender? How does it work and what is it's differences?

0 comments on commit 870a605

Please sign in to comment.