From c2728e17b3ec167358282fbe05f0ccb32dba4bbd Mon Sep 17 00:00:00 2001 From: Craig Date: Fri, 28 Jun 2019 20:39:30 +0100 Subject: [PATCH] create DeathSockets Internal Flow page. --- DeathSocket-Home.md | 1 + DeathSockets-Internal-Flow.md | 11 +++++++++++ Home.md | 2 ++ Source-Code-Home.md | 1 + _sidebar.md | 1 + 5 files changed, 16 insertions(+) create mode 100644 DeathSockets-Internal-Flow.md diff --git a/DeathSocket-Home.md b/DeathSocket-Home.md index 13fbac3..83801ec 100644 --- a/DeathSocket-Home.md +++ b/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) diff --git a/DeathSockets-Internal-Flow.md b/DeathSockets-Internal-Flow.md new file mode 100644 index 0000000..7dac169 --- /dev/null +++ b/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. diff --git a/Home.md b/Home.md index e3e288c..2b136a1 100644 --- a/Home.md +++ b/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 diff --git a/Source-Code-Home.md b/Source-Code-Home.md index 1ee357a..316f95f 100644 --- a/Source-Code-Home.md +++ b/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 diff --git a/_sidebar.md b/_sidebar.md index dbf6e66..b06e662 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -14,6 +14,7 @@ - [DeathSocket Home](DeathSocket-Home) - [DeathSocket's Flow](DeathSockets-Flow) +- [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) #### DeathSocketCLI