create DeathSockets Internal Flow page.

master
Craig Oates 5 years ago
parent
commit
c2728e17b3
  1. 1
      DeathSocket-Home.md
  2. 11
      DeathSockets-Internal-Flow.md
  3. 2
      Home.md
  4. 1
      Source-Code-Home.md
  5. 1
      _sidebar.md

1
DeathSocket-Home.md

@ -6,3 +6,4 @@ This section focuses on the source code within the project called "DeathSocket".
## Table of Contents
- [DeathSocket's Flow](DeathSockets-Flow)
- [DeathSocket's Internal Flow](DeathSockets-Internal-Flow)

11
DeathSockets-Internal-Flow.md

@ -0,0 +1,11 @@
Although the system has a restricted input-output (I/O) flow from the outside, the internal flow is a bit more flexible. There is still a rigidity to it but it is not as one-dimensional. To help explain, please consider the image below.
INTERFLOW FLOW IMAGE.
How this works is `GridPainter` receives input, usually a record type from `Domain`. From there, `GridPainter` utilises the various functions from the other files to complete the task it received. Because everything runs through`GridPainter`, it doubles up as the libraries co-ordinator. There is (for lack of a better word) no cross-pollination of function calls between the other files.
If you decide to add new features to the library, please try to keep to this flow/structure.
**Note**: The modules listed above are situated in files with the same names -- for example, `GridPainter` resides in "GridPainter.fs", `Domain` resides in "Domain.fs" Etc.
IMAGE OF MODULE TO FILENAME LINKS.

2
Home.md

@ -57,6 +57,8 @@ Before continuing, I recommend you are familiar with the following;
- [DeathSocket Home](DeathSocket-Home)
- [DeathSocket's Flow](DeathSockets-Flow)
- [DeathSocket's Internal Flow](DeathSockets-Internal-Flow)
#### DeathSocketCLI

1
Source-Code-Home.md

@ -12,6 +12,7 @@ This section is for those wanting to work with the repository's source code. If
- [DeathSocket Home](DeathSocket-Home)
- [DeathSocket's Flow](DeathSockets-Flow)
- [DeathSocket's Internal Flow](DeathSockets-Internal-Flow)
#### DeathSocketCLI

1
_sidebar.md

@ -14,6 +14,7 @@
- [DeathSocket Home](DeathSocket-Home)
- [DeathSocket's Flow](DeathSockets-Flow)
- [DeathSocket's Internal Flow](DeathSockets-Internal-Flow)
#### DeathSocketCLI

Loading…
Cancel
Save